iovalkey
    Preparing search index...

    Class Cluster

    Client for the official Redis Cluster

    Hierarchy

    • Commander
    • EventEmitter
    • Transaction
      • Cluster
    Index

    Constructors

    Properties

    Accessors

    Methods

    acl aclBuffer addBuiltinCommand append asking auth bgrewriteaof bgrewriteaofBuffer bgsave bitcount bitfield bitfield_ro bitop bitpos blmove blmoveBuffer blmpop blmpopBuffer blpop blpopBuffer brpop brpopBuffer brpoplpush brpoplpushBuffer bzmpop bzpopmax bzpopmaxBuffer bzpopmin bzpopminBuffer call callBuffer client clientBuffer cluster command config connect copy createBuiltinCommand dbsize debug decr decrby defineCommand del discard disconnect dump dumpBuffer duplicate echo echoBuffer eval eval_ro evalsha evalsha_ro exec exists expire expireat expiretime failover fcall fcall_ro flushall flushdb geoadd geodist geodistBuffer geohash geohashBuffer geopos georadius georadius_ro georadiusbymember georadiusbymember_ro geosearch geosearchstore get getbit getBuffer getBuiltinCommands getdel getdelBuffer getex getexBuffer getrange getrangeBuffer getset getsetBuffer hdel hello hexists hget hgetall hgetallBuffer hgetBuffer hincrby hincrbyfloat hincrbyfloatBuffer hkeys hkeysBuffer hlen hmget hmgetBuffer hmset hrandfield hrandfieldBuffer hscan hscanBuffer hscanBufferStream hscanStream hset hsetnx hstrlen hvals hvalsBuffer incr incrby incrbyfloat info keys keysBuffer lastsave latency lcs lindex lindexBuffer linsert llen lmove lmoveBuffer lmpop lmpopBuffer lolwut lpop lpopBuffer lpos lpush lpushx lrange lrangeBuffer lrem lset ltrim memory mget mgetBuffer migrate module move mset msetnx multi nodes object persist pexpire pexpireat pexpiretime pfadd pfcount pfdebug pfmerge pfselftest ping pingBuffer pipeline psetex psubscribe psync pttl publish pubsub punsubscribe quit randomkey randomkeyBuffer readonly readwrite rename renamenx replconf replicaof reset restore restore-asking role rpop rpopBuffer rpoplpush rpoplpushBuffer rpush rpushx sadd save scan scanBuffer scard script sdiff sdiffBuffer sdiffstore select set setbit setBuffer setex setnx setrange shutdown sinter sinterBuffer sintercard sinterstore sismember slaveof slowlog smembers smembersBuffer smismember smove sort sort_ro spop spopBuffer spublish srandmember srandmemberBuffer srem sscan sscanBuffer sscanBufferStream sscanStream ssubscribe strlen subscribe substr sunion sunionBuffer sunionstore sunsubscribe swapdb sync time touch ttl type unlink unsubscribe unwatch wait waitaof watch xack xadd xaddBuffer xautoclaim xclaim xdel xgroup xinfo xlen xpending xrange xrangeBuffer xread xreadBuffer xreadgroup xrevrange xrevrangeBuffer xsetid xtrim zadd zaddBuffer zcard zcount zdiff zdiffBuffer zdiffstore zincrby zincrbyBuffer zinter zinterBuffer zintercard zinterstore zlexcount zmpop zmscore zmscoreBuffer zpopmax zpopmaxBuffer zpopmin zpopminBuffer zrandmember zrandmemberBuffer zrange zrangeBuffer zrangebylex zrangebylexBuffer zrangebyscore zrangebyscoreBuffer zrangestore zrank zrem zremrangebylex zremrangebyrank zremrangebyscore zrevrange zrevrangeBuffer zrevrangebylex zrevrangebylexBuffer zrevrangebyscore zrevrangebyscoreBuffer zrevrank zscan zscanBuffer zscanBufferStream zscanStream zscore zscoreBuffer zunion zunionBuffer zunionstore

    Constructors

    Properties

    slots: string[][] = []
    status: ClusterStatus

    Accessors

    • get autoPipelineQueueSize(): number

      Get the number of commands queued in automatic pipelines.

      This is not available (and returns 0) until the cluster is connected and slots information have been received.

      Returns number

    Methods

    • Lists the ACL categories, or the commands inside a category.

      • group: server
      • complexity: O(1) since the categories and commands are a fixed set.
      • since: 6.0.0

      Parameters

      • subcommand: "CAT"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "CAT"
      • category: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Deletes ACL users, and terminates their connections.

      • group: server
      • complexity: O(1) amortized time considering the typical user.
      • since: 6.0.0

      Parameters

      • ...args: [
            subcommand: "DELUSER",
            ...usernames: (string | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[]]

      Returns Promise<number>

    • Simulates the execution of a command by a user, without executing the command.

      • group: server
      • complexity: O(1).
      • since: 7.0.0

      Parameters

      • subcommand: "DRYRUN"
      • username: string | Buffer
      • command: string | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • ...args: [
            subcommand: "DRYRUN",
            username: string
            | Buffer,
            command: string | Buffer,
            ...args: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            subcommand: "DRYRUN",
            username: string
            | Buffer,
            command: string | Buffer,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Generates a pseudorandom, secure password that can be used to identify ACL users.

      • group: server
      • complexity: O(1)
      • since: 6.0.0

      Parameters

      • subcommand: "GENPASS"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • subcommand: "GENPASS"
      • bits: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Lists the ACL rules of a user.

      • group: server
      • complexity: O(N). Where N is the number of password, command and pattern rules that the user has.
      • since: 6.0.0

      Parameters

      • subcommand: "GETUSER"
      • username: string | Buffer
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Returns helpful text about the different subcommands.

      • group: server
      • complexity: O(1)
      • since: 6.0.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Dumps the effective rules in ACL file format.

      • group: server
      • complexity: O(N). Where N is the number of configured users.
      • since: 6.0.0

      Parameters

      • subcommand: "LIST"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Reloads the rules from the configured ACL file.

      • group: server
      • complexity: O(N). Where N is the number of configured users.
      • since: 6.0.0

      Parameters

      • subcommand: "LOAD"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Lists recent security events generated due to ACL rules.

      • group: server
      • complexity: O(N) with N being the number of entries shown.
      • since: 6.0.0

      Parameters

      • subcommand: "LOG"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "LOG"
      • count: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "LOG"
      • reset: "RESET"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Saves the effective ACL rules in the configured ACL file.

      • group: server
      • complexity: O(N). Where N is the number of configured users.
      • since: 6.0.0

      Parameters

      • subcommand: "SAVE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Creates and modifies an ACL user and its rules.

      • group: server
      • complexity: O(N). Where N is the number of rules provided.
      • since: 6.0.0

      Parameters

      • subcommand: "SETUSER"
      • username: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            subcommand: "SETUSER",
            username: string
            | Buffer,
            ...rules: (string | Buffer)[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            subcommand: "SETUSER",
            username: string
            | Buffer,
            ...rules: (string | Buffer)[],
        ]

      Returns Promise<"OK">

    • Lists all ACL users.

      • group: server
      • complexity: O(N). Where N is the number of configured users.
      • since: 6.0.0

      Parameters

      • subcommand: "USERS"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Returns the authenticated username of the current connection.

      • group: server
      • complexity: O(1)
      • since: 6.0.0

      Parameters

      • subcommand: "WHOAMI"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • subcommand: "DRYRUN"
      • username: string | Buffer
      • command: string | Buffer
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            subcommand: "DRYRUN",
            username: string
            | Buffer,
            command: string | Buffer,
            ...args: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            subcommand: "DRYRUN",
            username: string
            | Buffer,
            command: string | Buffer,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • subcommand: "GENPASS"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • subcommand: "GENPASS"
      • bits: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • subcommand: "GETUSER"
      • username: string | Buffer
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • subcommand: "LIST"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • subcommand: "USERS"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • subcommand: "WHOAMI"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Create add builtin command

      Parameters

      • commandName: string

      Returns void

    • Appends a string to the value of a key. Creates the key if it doesn't exist.

      • group: string
      • complexity: O(1). The amortized time complexity is O(1) assuming the appended value is small and the already present value is of any size, since the dynamic string library used by the server will double the free space available on every reallocation.
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Signals that a cluster client is following an -ASK redirect.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Authenticates the connection.

      • group: connection
      • complexity: O(N) where N is the number of passwords defined for the user
      • since: 1.0.0

      Parameters

      • password: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • username: string | Buffer
      • password: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Asynchronously rewrites the append-only file to disk.

      • group: server
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Asynchronously saves the database(s) to disk.

      • group: server
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • schedule: "SCHEDULE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Counts the number of set bits (population counting) in a string.

      • group: bitmap
      • complexity: O(N)
      • since: 2.6.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • start: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • start: string | number
      • end: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • start: string | number
      • end: string | number
      • byte: "BYTE"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • start: string | number
      • end: string | number
      • bit: "BIT"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Performs arbitrary bitfield integer operations on strings.

      • group: bitmap
      • complexity: O(1) for each subcommand specified
      • since: 3.2.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • getBlockToken: "GET"
      • encoding: string | Buffer
      • offset: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • setBlockToken: "SET"
      • encoding: string | Buffer
      • offset: string | number
      • value: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • incrbyBlockToken: "INCRBY"
      • encoding: string | Buffer
      • offset: string | number
      • increment: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • overflow: "OVERFLOW"
      • wrap: "WRAP"
      • setBlockToken: "SET"
      • encoding: string | Buffer
      • offset: string | number
      • value: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • overflow: "OVERFLOW"
      • wrap: "WRAP"
      • incrbyBlockToken: "INCRBY"
      • encoding: string | Buffer
      • offset: string | number
      • increment: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • overflow: "OVERFLOW"
      • sat: "SAT"
      • setBlockToken: "SET"
      • encoding: string | Buffer
      • offset: string | number
      • value: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • overflow: "OVERFLOW"
      • sat: "SAT"
      • incrbyBlockToken: "INCRBY"
      • encoding: string | Buffer
      • offset: string | number
      • increment: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • overflow: "OVERFLOW"
      • fail: "FAIL"
      • setBlockToken: "SET"
      • encoding: string | Buffer
      • offset: string | number
      • value: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • overflow: "OVERFLOW"
      • fail: "FAIL"
      • incrbyBlockToken: "INCRBY"
      • encoding: string | Buffer
      • offset: string | number
      • increment: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Performs arbitrary read-only bitfield integer operations on strings.

      • group: bitmap
      • complexity: O(1) for each subcommand specified
      • since: 6.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            getBlockToken: "GET",
            ...getBlocks: (string | number | Buffer)[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            getBlockToken: "GET",
            ...getBlocks: (string | number | Buffer)[],
        ]

      Returns Promise<unknown[]>

    • Performs bitwise operations on multiple strings, and stores the result.

      • group: bitmap
      • complexity: O(N)
      • since: 2.6.0

      Parameters

      • ...args: [and: "AND", destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [and: "AND", destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      • ...args: [or: "OR", destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [or: "OR", destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      • ...args: [xor: "XOR", destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [xor: "XOR", destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      • ...args: [not: "NOT", destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [not: "NOT", destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Finds the first set (1) or clear (0) bit in a string.

      • group: bitmap
      • complexity: O(N)
      • since: 2.8.7

      Parameters

      • key: RedisKey
      • bit: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • bit: string | number
      • start: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • bit: string | number
      • start: string | number
      • end: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • bit: string | number
      • start: string | number
      • end: string | number
      • byte: "BYTE"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • bit: string | number
      • start: string | number
      • end: string | number
      • bit1: "BIT"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Pops an element from a list, pushes it to another list and returns it. Blocks until an element is available otherwise. Deletes the list if the last element was moved.

      • group: list
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • source: RedisKey
      • destination: RedisKey
      • left: "LEFT"
      • left1: "LEFT"
      • timeout: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • left: "LEFT"
      • right: "RIGHT"
      • timeout: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • right: "RIGHT"
      • left: "LEFT"
      • timeout: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • right: "RIGHT"
      • right1: "RIGHT"
      • timeout: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • left: "LEFT"
      • left1: "LEFT"
      • timeout: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • left: "LEFT"
      • right: "RIGHT"
      • timeout: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • right: "RIGHT"
      • left: "LEFT"
      • timeout: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • right: "RIGHT"
      • right1: "RIGHT"
      • timeout: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Pops the first element from one of multiple lists. Blocks until an element is available otherwise. Deletes the list if the last element was popped.

      • group: list
      • complexity: O(N+M) where N is the number of provided keys and M is the number of elements returned.
      • since: 7.0.0

      Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            left: "LEFT",
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            left: "LEFT",
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            left: "LEFT",
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            left: "LEFT",
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            right: "RIGHT",
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            right: "RIGHT",
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            right: "RIGHT",
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            left: "LEFT",
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            left: "LEFT",
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            left: "LEFT",
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            left: "LEFT",
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            right: "RIGHT",
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            right: "RIGHT",
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            right: "RIGHT",
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Removes and returns the first element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.

      • group: list
      • complexity: O(N) where N is the number of provided keys.
      • since: 2.0.0

      Parameters

      • ...args: [
            ...keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[string, string]>,
        ]

      Returns Promise<[string, string]>

    • Parameters

      • ...args: [
            keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[string, string]>,
        ]

      Returns Promise<[string, string]>

    • Parameters

      • ...args: [...keys: RedisKey[], timeout: string | number]

      Returns Promise<[string, string]>

    • Parameters

      • ...args: [keys: RedisKey[], timeout: string | number]

      Returns Promise<[string, string]>

    • Parameters

      • ...args: [
            ...keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[Buffer, Buffer]>,
        ]

      Returns Promise<[Buffer, Buffer]>

    • Parameters

      • ...args: [
            keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[Buffer, Buffer]>,
        ]

      Returns Promise<[Buffer, Buffer]>

    • Parameters

      • ...args: [...keys: RedisKey[], timeout: string | number]

      Returns Promise<[Buffer, Buffer]>

    • Parameters

      • ...args: [keys: RedisKey[], timeout: string | number]

      Returns Promise<[Buffer, Buffer]>

    • Removes and returns the last element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.

      • group: list
      • complexity: O(N) where N is the number of provided keys.
      • since: 2.0.0

      Parameters

      • ...args: [
            ...keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[string, string]>,
        ]

      Returns Promise<[string, string]>

    • Parameters

      • ...args: [
            keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[string, string]>,
        ]

      Returns Promise<[string, string]>

    • Parameters

      • ...args: [...keys: RedisKey[], timeout: string | number]

      Returns Promise<[string, string]>

    • Parameters

      • ...args: [keys: RedisKey[], timeout: string | number]

      Returns Promise<[string, string]>

    • Parameters

      • ...args: [
            ...keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[Buffer, Buffer]>,
        ]

      Returns Promise<[Buffer, Buffer]>

    • Parameters

      • ...args: [
            keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[Buffer, Buffer]>,
        ]

      Returns Promise<[Buffer, Buffer]>

    • Parameters

      • ...args: [...keys: RedisKey[], timeout: string | number]

      Returns Promise<[Buffer, Buffer]>

    • Parameters

      • ...args: [keys: RedisKey[], timeout: string | number]

      Returns Promise<[Buffer, Buffer]>

    • Pops an element from a list, pushes it to another list and returns it. Block until an element is available otherwise. Deletes the list if the last element was popped.

      • group: list
      • complexity: O(1)
      • since: 2.2.0

      Parameters

      • source: RedisKey
      • destination: RedisKey
      • timeout: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • timeout: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Removes and returns a member by score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.

      • group: sorted-set
      • complexity: O(K) + O(M*log(N)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped.
      • since: 7.0.0

      Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            min: "MIN",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            min: "MIN",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            min: "MIN",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            min: "MIN",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            min: "MIN",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            min: "MIN",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            min: "MIN",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            min: "MIN",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            max: "MAX",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            max: "MAX",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            max: "MAX",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            max: "MAX",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            max: "MAX",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            max: "MAX",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            ...keys: RedisKey[],
            max: "MAX",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            timeout: string
            | number,
            numkeys: string | number,
            keys: RedisKey[],
            max: "MAX",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<unknown>

    • Removes and returns the member with the highest score from one or more sorted sets. Blocks until a member available otherwise. Deletes the sorted set if the last element was popped.

      • group: sorted-set
      • complexity: O(log(N)) with N being the number of elements in the sorted set.
      • since: 5.0.0

      Parameters

      • ...args: [
            ...keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[key: string, member: string, score: string]>,
        ]

      Returns Promise<[key: string, member: string, score: string]>

    • Parameters

      • ...args: [
            keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[key: string, member: string, score: string]>,
        ]

      Returns Promise<[key: string, member: string, score: string]>

    • Parameters

      • ...args: [...keys: RedisKey[], timeout: string | number]

      Returns Promise<[key: string, member: string, score: string]>

    • Parameters

      • ...args: [keys: RedisKey[], timeout: string | number]

      Returns Promise<[key: string, member: string, score: string]>

    • Parameters

      • ...args: [
            ...keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
        ]

      Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>

    • Parameters

      • ...args: [
            keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
        ]

      Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>

    • Parameters

      • ...args: [...keys: RedisKey[], timeout: string | number]

      Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>

    • Parameters

      • ...args: [keys: RedisKey[], timeout: string | number]

      Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>

    • Removes and returns the member with the lowest score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.

      • group: sorted-set
      • complexity: O(log(N)) with N being the number of elements in the sorted set.
      • since: 5.0.0

      Parameters

      • ...args: [
            ...keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[key: string, member: string, score: string]>,
        ]

      Returns Promise<[key: string, member: string, score: string]>

    • Parameters

      • ...args: [
            keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[key: string, member: string, score: string]>,
        ]

      Returns Promise<[key: string, member: string, score: string]>

    • Parameters

      • ...args: [...keys: RedisKey[], timeout: string | number]

      Returns Promise<[key: string, member: string, score: string]>

    • Parameters

      • ...args: [keys: RedisKey[], timeout: string | number]

      Returns Promise<[key: string, member: string, score: string]>

    • Parameters

      • ...args: [
            ...keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
        ]

      Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>

    • Parameters

      • ...args: [
            keys: RedisKey[],
            timeout: string
            | number,
            callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
        ]

      Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>

    • Parameters

      • ...args: [...keys: RedisKey[], timeout: string | number]

      Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>

    • Parameters

      • ...args: [keys: RedisKey[], timeout: string | number]

      Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>

    • Call arbitrary commands.

      redis.call('set', 'foo', 'bar') is the same as redis.set('foo', 'bar'), so the only case you need to use this method is when the command is not supported by ioredis.

      redis.call('set', 'foo', 'bar');
      redis.call('get', 'foo', (err, value) => {
      // value === 'bar'
      });

      Parameters

      • command: string
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • command: string
      • args: (string | number | Buffer)[]
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            command: string,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [command: string, ...args: (string | number | Buffer)[]]

      Returns Promise<unknown>

    • Parameters

      • command: string
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • command: string
      • args: (string | number | Buffer)[]
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            command: string,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [command: string, ...args: (string | number | Buffer)[]]

      Returns Promise<unknown>

    • Instructs the server whether to track the keys in the next request.

      • group: connection
      • complexity: O(1)
      • since: 6.0.0

      Parameters

      • subcommand: "CACHING"
      • yes: "YES"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "CACHING"
      • no: "NO"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • A client claims its capability.

      • group: connection
      • complexity: O(1)
      • since: 8.0.0

      Parameters

      • ...args: [
            subcommand: "CAPA",
            ...capabilities: (string | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [subcommand: "CAPA", ...capabilities: (string | Buffer)[]]

      Returns Promise<unknown>

    • Returns the name of the connection.

      • group: connection
      • complexity: O(1)
      • since: 2.6.9

      Parameters

      • subcommand: "GETNAME"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Returns the client ID to which the connection's tracking notifications are redirected.

      • group: connection
      • complexity: O(1)
      • since: 6.0.0

      Parameters

      • subcommand: "GETREDIR"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns helpful text about the different subcommands.

      • group: connection
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the unique client ID of the connection.

      • group: connection
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "ID"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns information about the connection.

      • group: connection
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • subcommand: "INFO"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Terminates open connections.

      • group: connection
      • complexity: O(N) where N is the number of client connections
      • since: 2.4.0

      Parameters

      • subcommand: "KILL"
      • oldFormat: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • clientIdToken: "ID"
      • clientId: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • type: "TYPE"
      • normal: "NORMAL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • type: "TYPE"
      • master: "MASTER"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • type: "TYPE"
      • primary: "PRIMARY"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • type: "TYPE"
      • slave: "SLAVE"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • type: "TYPE"
      • replica: "REPLICA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • type: "TYPE"
      • pubsub: "PUBSUB"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • usernameToken: "USER"
      • username: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • addrToken: "ADDR"
      • addr: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • laddrToken: "LADDR"
      • laddr: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • skipme: "SKIPME"
      • yes: "YES"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • skipme: "SKIPME"
      • no: "NO"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "KILL"
      • maxageToken: "MAXAGE"
      • maxage: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Lists open connections.

      • group: connection
      • complexity: O(N) where N is the number of client connections
      • since: 2.4.0

      Parameters

      • subcommand: "LIST"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LIST",
            clientIdToken: "ID",
            ...clientIds: (string | number)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [subcommand: "LIST", clientIdToken: "ID", ...clientIds: (string | number)[]]

      Returns Promise<unknown>

    • Parameters

      • subcommand: "LIST"
      • type: "TYPE"
      • normal: "NORMAL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LIST",
            type: "TYPE",
            normal: "NORMAL",
            clientIdToken: "ID",
            ...clientIds: (string | number)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LIST",
            type: "TYPE",
            normal: "NORMAL",
            clientIdToken: "ID",
            ...clientIds: (string | number)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • subcommand: "LIST"
      • type: "TYPE"
      • master: "MASTER"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LIST",
            type: "TYPE",
            master: "MASTER",
            clientIdToken: "ID",
            ...clientIds: (string | number)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LIST",
            type: "TYPE",
            master: "MASTER",
            clientIdToken: "ID",
            ...clientIds: (string | number)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • subcommand: "LIST"
      • type: "TYPE"
      • replica: "REPLICA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LIST",
            type: "TYPE",
            replica: "REPLICA",
            clientIdToken: "ID",
            ...clientIds: (string | number)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LIST",
            type: "TYPE",
            replica: "REPLICA",
            clientIdToken: "ID",
            ...clientIds: (string | number)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • subcommand: "LIST"
      • type: "TYPE"
      • pubsub: "PUBSUB"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LIST",
            type: "TYPE",
            pubsub: "PUBSUB",
            clientIdToken: "ID",
            ...clientIds: (string | number)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LIST",
            type: "TYPE",
            pubsub: "PUBSUB",
            clientIdToken: "ID",
            ...clientIds: (string | number)[],
        ]

      Returns Promise<unknown>

    • Sets the client eviction mode of the connection.

      • group: connection
      • complexity: O(1)
      • since: 7.0.0

      Parameters

      • subcommand: "NO-EVICT"
      • on: "ON"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "NO-EVICT"
      • off: "OFF"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Controls whether commands sent by the client affect the LRU/LFU of accessed keys.

      • group: connection
      • complexity: O(1)
      • since: 7.2.0

      Parameters

      • subcommand: "NO-TOUCH"
      • on: "ON"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "NO-TOUCH"
      • off: "OFF"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Suspends commands processing.

      • group: connection
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "PAUSE"
      • timeout: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "PAUSE"
      • timeout: string | number
      • write: "WRITE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "PAUSE"
      • timeout: string | number
      • all: "ALL"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Instructs the server whether to reply to commands.

      • group: connection
      • complexity: O(1)
      • since: 3.2.0

      Parameters

      • subcommand: "REPLY"
      • on: "ON"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "REPLY"
      • off: "OFF"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "REPLY"
      • skip: "SKIP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Sets information specific to the client or connection.

      • group: connection
      • complexity: O(1)
      • since: 7.2.0

      Parameters

      • subcommand: "SETINFO"
      • libnameToken: "LIB-NAME"
      • libname: string | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • subcommand: "SETINFO"
      • libverToken: "LIB-VER"
      • libver: string | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Sets the connection name.

      • group: connection
      • complexity: O(1)
      • since: 2.6.9

      Parameters

      • subcommand: "SETNAME"
      • connectionName: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Controls server-assisted client-side caching for the connection.

      • group: connection
      • complexity: O(1). Some options may introduce additional complexity.
      • since: 6.0.0

      Parameters

      • ...args: [subcommand: "TRACKING", ...args: RedisValue[], callback: Callback<unknown>]

      Returns Promise<unknown>

    • Parameters

      • ...args: [subcommand: "TRACKING", ...args: RedisValue[]]

      Returns Promise<unknown>

    • Returns information about server-assisted client-side caching for the connection.

      • group: connection
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • subcommand: "TRACKINGINFO"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Unblocks a client blocked by a blocking command from a different connection.

      • group: connection
      • complexity: O(log N) where N is the number of client connections
      • since: 5.0.0

      Parameters

      • subcommand: "UNBLOCK"
      • clientId: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "UNBLOCK"
      • clientId: string | number
      • timeout: "TIMEOUT"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "UNBLOCK"
      • clientId: string | number
      • error: "ERROR"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Resumes processing commands from paused clients.

      • group: connection
      • complexity: O(N) Where N is the number of paused clients
      • since: 6.2.0

      Parameters

      • subcommand: "UNPAUSE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "GETNAME"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • subcommand: "INFO"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • subcommand: "SETINFO"
      • libnameToken: "LIB-NAME"
      • libname: string | Buffer
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • subcommand: "SETINFO"
      • libverToken: "LIB-VER"
      • libver: string | Buffer
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • subcommand: "TRACKINGINFO"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Assigns new hash slots to a node.

      • group: cluster
      • complexity: O(N) where N is the total number of hash slot arguments
      • since: 3.0.0

      Parameters

      • ...args: [
            subcommand: "ADDSLOTS",
            ...slots: (string | number)[],
            callback: Callback<
                [
                    startSlotRange: number,
                    endSlotRange: number,
                    ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
                ][],
            >,
        ]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Parameters

      • ...args: [
            subcommand: "ADDSLOTS",
            slots: (string | number)[],
            callback: Callback<
                [
                    startSlotRange: number,
                    endSlotRange: number,
                    ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
                ][],
            >,
        ]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Parameters

      • ...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[]]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Parameters

      • ...args: [subcommand: "ADDSLOTS", slots: (string | number)[]]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Assigns new hash slot ranges to a node.

      • group: cluster
      • complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments.
      • since: 7.0.0

      Parameters

      • ...args: [
            subcommand: "ADDSLOTSRANGE",
            ...ranges: (string | number)[],
            callback: Callback<
                [
                    startSlotRange: number,
                    endSlotRange: number,
                    ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
                ][],
            >,
        ]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Parameters

      • ...args: [subcommand: "ADDSLOTSRANGE", ...ranges: (string | number)[]]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Advances the cluster config epoch.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "BUMPEPOCH"
      • Optionalcallback: Callback<"BUMPED" | "STILL">

      Returns Promise<"BUMPED" | "STILL">

    • Returns the number of active failure reports active for a node.

      • group: cluster
      • complexity: O(N) where N is the number of failure reports
      • since: 3.0.0

      Parameters

      • subcommand: "COUNT-FAILURE-REPORTS"
      • nodeId: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the number of keys in a hash slot.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "COUNTKEYSINSLOT"
      • slot: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Sets hash slots as unbound for a node.

      • group: cluster
      • complexity: O(N) where N is the total number of hash slot arguments
      • since: 3.0.0

      Parameters

      • ...args: [
            subcommand: "DELSLOTS",
            ...slots: (string | number)[],
            callback: Callback<
                [
                    startSlotRange: number,
                    endSlotRange: number,
                    ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
                ][],
            >,
        ]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Parameters

      • ...args: [
            subcommand: "DELSLOTS",
            slots: (string | number)[],
            callback: Callback<
                [
                    startSlotRange: number,
                    endSlotRange: number,
                    ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
                ][],
            >,
        ]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Parameters

      • ...args: [subcommand: "DELSLOTS", ...slots: (string | number)[]]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Parameters

      • ...args: [subcommand: "DELSLOTS", slots: (string | number)[]]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Sets hash slot ranges as unbound for a node.

      • group: cluster
      • complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments.
      • since: 7.0.0

      Parameters

      • ...args: [
            subcommand: "DELSLOTSRANGE",
            ...ranges: (string | number)[],
            callback: Callback<
                [
                    startSlotRange: number,
                    endSlotRange: number,
                    ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
                ][],
            >,
        ]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Parameters

      • ...args: [subcommand: "DELSLOTSRANGE", ...ranges: (string | number)[]]

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Forces a replica to perform a manual failover of its primary.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "FAILOVER"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "FAILOVER"
      • force: "FORCE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "FAILOVER"
      • takeover: "TAKEOVER"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Deletes all slots information from a node.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "FLUSHSLOTS"
      • Optionalcallback: Callback<
            [
                startSlotRange: number,
                endSlotRange: number,
                ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
            ][],
        >

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Removes a node from the nodes table.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "FORGET"
      • nodeId: string | number | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Returns the key names in a hash slot.

      • group: cluster
      • complexity: O(N) where N is the number of requested keys
      • since: 3.0.0

      Parameters

      • subcommand: "GETKEYSINSLOT"
      • slot: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Returns helpful text about the different subcommands.

      • group: cluster
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns information about the state of a node.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "INFO"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Returns the hash slot for a key.

      • group: cluster
      • complexity: O(N) where N is the number of bytes in the key
      • since: 3.0.0

      Parameters

      • subcommand: "KEYSLOT"
      • key: string | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns a list of all TCP links to and from peer nodes.

      • group: cluster
      • complexity: O(N) where N is the total number of Cluster nodes
      • since: 7.0.0

      Parameters

      • subcommand: "LINKS"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Forces a node to handshake with another node.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "MEET"
      • ip: string | Buffer
      • port: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "MEET"
      • ip: string | Buffer
      • port: string | number
      • clusterBusPort: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Returns the ID of a node.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "MYID"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Returns the shard ID of a node.

      • group: cluster
      • complexity: O(1)
      • since: 7.2.0

      Parameters

      • subcommand: "MYSHARDID"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the cluster configuration for a node.

      • group: cluster
      • complexity: O(N) where N is the total number of Cluster nodes
      • since: 3.0.0

      Parameters

      • subcommand: "NODES"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Lists the replica nodes of a primary node.

      • group: cluster
      • complexity: O(N) where N is the number of replicas.
      • since: 5.0.0

      Parameters

      • subcommand: "REPLICAS"
      • nodeId: string | number | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Configure a node as replica of a primary node.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "REPLICATE"
      • nodeId: string | number | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Resets a node.

      • group: cluster
      • complexity: O(N) where N is the number of known nodes. The command may execute a FLUSHALL as a side effect.
      • since: 3.0.0

      Parameters

      • subcommand: "RESET"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "RESET"
      • hard: "HARD"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "RESET"
      • soft: "SOFT"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Forces a node to save the cluster configuration to disk.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "SAVECONFIG"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Sets the configuration epoch for a new node.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "SET-CONFIG-EPOCH"
      • configEpoch: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Binds a hash slot to a node.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • subcommand: "SETSLOT"
      • slot: string | number
      • importingToken: "IMPORTING"
      • importing: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "SETSLOT"
      • slot: string | number
      • importingToken: "IMPORTING"
      • importing: string | Buffer
      • timeoutToken: "TIMEOUT"
      • timeout: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "SETSLOT"
      • slot: string | number
      • migratingToken: "MIGRATING"
      • migrating: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "SETSLOT"
      • slot: string | number
      • migratingToken: "MIGRATING"
      • migrating: string | Buffer
      • timeoutToken: "TIMEOUT"
      • timeout: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "SETSLOT"
      • slot: string | number
      • nodeToken: "NODE"
      • node: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "SETSLOT"
      • slot: string | number
      • nodeToken: "NODE"
      • node: string | Buffer
      • timeoutToken: "TIMEOUT"
      • timeout: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "SETSLOT"
      • slot: string | number
      • stable: "STABLE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • subcommand: "SETSLOT"
      • slot: string | number
      • stable: "STABLE"
      • timeoutToken: "TIMEOUT"
      • timeout: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Returns the mapping of cluster slots to shards.

      • group: cluster
      • complexity: O(N) where N is the total number of cluster nodes
      • since: 7.0.0

      Parameters

      • subcommand: "SHARDS"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Lists the replica nodes of a primary node.

      • group: cluster
      • complexity: O(N) where N is the number of replicas.
      • since: 3.0.0

      Parameters

      • subcommand: "SLAVES"
      • nodeId: string | number | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Return an array of slot usage statistics for slots assigned to the current node.

      • group: cluster
      • complexity: O(N) where N is the total number of slots based on arguments. O(N*log(N)) with ORDERBY subcommand.
      • since: 8.0.0

      Parameters

      • subcommand: "SLOT-STATS"
      • slotsrangeToken: "SLOTSRANGE"
      • startSlot: string | number
      • endSlot: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "SLOT-STATS"
      • orderbyToken: "ORDERBY"
      • metric: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "SLOT-STATS"
      • orderbyToken: "ORDERBY"
      • metric: string | Buffer
      • asc: "ASC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "SLOT-STATS"
      • orderbyToken: "ORDERBY"
      • metric: string | Buffer
      • desc: "DESC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "SLOT-STATS"
      • orderbyToken: "ORDERBY"
      • metric: string | Buffer
      • limitToken: "LIMIT"
      • limit: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "SLOT-STATS"
      • orderbyToken: "ORDERBY"
      • metric: string | Buffer
      • limitToken: "LIMIT"
      • limit: string | number
      • asc: "ASC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "SLOT-STATS"
      • orderbyToken: "ORDERBY"
      • metric: string | Buffer
      • limitToken: "LIMIT"
      • limit: string | number
      • desc: "DESC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the mapping of cluster slots to nodes.

      • group: cluster
      • complexity: O(N) where N is the total number of Cluster nodes
      • since: 3.0.0

      Parameters

      • subcommand: "SLOTS"
      • Optionalcallback: Callback<
            [
                startSlotRange: number,
                endSlotRange: number,
                ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
            ][],
        >

      Returns Promise<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >

    • Returns a count of commands.

      • group: server
      • complexity: O(1)
      • since: 2.8.13

      Parameters

      • subcommand: "COUNT"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns documentary information about one, multiple or all commands.

      • group: server
      • complexity: O(N) where N is the number of commands to look up
      • since: 7.0.0

      Parameters

      • subcommand: "DOCS"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            subcommand: "DOCS",
            ...commandNames: (string | Buffer)[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[]]

      Returns Promise<unknown[]>

    • Extracts the key names from an arbitrary command.

      • group: server
      • complexity: O(N) where N is the number of arguments to the command
      • since: 2.8.13

      Parameters

      • subcommand: "GETKEYS"
      • command: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            subcommand: "GETKEYS",
            command: string
            | Buffer,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            subcommand: "GETKEYS",
            command: string
            | Buffer,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<unknown[]>

    • Extracts the key names and access flags for an arbitrary command.

      • group: server
      • complexity: O(N) where N is the number of arguments to the command
      • since: 7.0.0

      Parameters

      • subcommand: "GETKEYSANDFLAGS"
      • command: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            subcommand: "GETKEYSANDFLAGS",
            command: string
            | Buffer,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            subcommand: "GETKEYSANDFLAGS",
            command: string
            | Buffer,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<unknown[]>

    • Returns helpful text about the different subcommands.

      • group: server
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns information about one, multiple or all commands.

      • group: server
      • complexity: O(N) where N is the number of commands to look up
      • since: 2.8.13

      Parameters

      • subcommand: "INFO"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            subcommand: "INFO",
            ...commandNames: (string | Buffer)[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[]]

      Returns Promise<unknown[]>

    • Returns a list of command names.

      • group: server
      • complexity: O(N) where N is the total number of commands
      • since: 7.0.0

      Parameters

      • subcommand: "LIST"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • subcommand: "LIST"
      • filterby: "FILTERBY"
      • moduleNameToken: "MODULE"
      • moduleName: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • subcommand: "LIST"
      • filterby: "FILTERBY"
      • categoryToken: "ACLCAT"
      • category: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • subcommand: "LIST"
      • filterby: "FILTERBY"
      • patternToken: "PATTERN"
      • pattern: string
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns the effective values of configuration parameters.

      • group: server
      • complexity: O(N) when N is the number of configuration parameters provided
      • since: 2.0.0

      Parameters

      • ...args: [
            subcommand: "GET",
            ...parameters: (string | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [subcommand: "GET", ...parameters: (string | Buffer)[]]

      Returns Promise<unknown>

    • Returns helpful text about the different subcommands.

      • group: server
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Resets the server's statistics.

      • group: server
      • complexity: O(1)
      • since: 2.0.0

      Parameters

      • subcommand: "RESETSTAT"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Persists the effective configuration to file.

      • group: server
      • complexity: O(1)
      • since: 2.8.0

      Parameters

      • subcommand: "REWRITE"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Sets configuration parameters in-flight.

      • group: server
      • complexity: O(N) when N is the number of configuration parameters provided
      • since: 2.0.0

      Parameters

      • ...args: [
            subcommand: "SET",
            ...data: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [subcommand: "SET", ...data: (string | number | Buffer)[]]

      Returns Promise<unknown>

    • Copies the value of a key to a new key.

      • group: generic
      • complexity: O(N) worst case for collections, where N is the number of nested items. O(1) for string values.
      • since: 6.2.0

      Parameters

      Returns Promise<number>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • replace: "REPLACE"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • destinationDbToken: "DB"
      • destinationDb: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • destinationDbToken: "DB"
      • destinationDb: string | number
      • replace: "REPLACE"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Create a builtin command

      Parameters

      • commandName: string

      Returns { buffer: any; string: any }

    • Returns the number of keys in the database.

      • group: server
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • A container for debugging commands.

      • group: server
      • complexity: Depends on subcommand.
      • since: 1.0.0

      Parameters

      • subcommand: string
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: string,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [subcommand: string, ...args: (string | number | Buffer)[]]

      Returns Promise<unknown>

    • Decrements the integer value of a key by one. Uses 0 as initial value if the key doesn't exist.

      • group: string
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Decrements a number from the integer value of a key. Uses 0 as initial value if the key doesn't exist.

      • group: string
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • decrement: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Define a custom command using lua script

      Parameters

      • name: string
      • definition: { lua: string; numberOfKeys?: number; readOnly?: boolean }

      Returns void

    • Deletes one or more keys.

      • group: generic
      • complexity: O(N) where N is the number of keys that will be removed. When a key to remove holds a value other than a string, the individual complexity for this key is O(M) where M is the number of elements in the list, set, sorted set or hash. Removing a single key that holds a string value is O(1).
      • since: 1.0.0

      Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Discards a transaction.

      • group: transactions
      • complexity: O(N), when N is the number of queued commands
      • since: 2.0.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Disconnect from every node in the cluster.

      Parameters

      • reconnect: boolean = false

      Returns void

    • Returns a serialized representation of the value stored at a key.

      • group: generic
      • complexity: O(1) to access the key and additional O(NM) to serialize it, where N is the number of objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1).
      • since: 2.6.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Create a new instance with the same startup nodes and options as the current one.

      Parameters

      • overrideStartupNodes: any[] = []
      • overrideOptions: {} = {}

      Returns Cluster

      var cluster = new Redis.Cluster([{ host: "127.0.0.1", port: "30001" }]);
      var anotherCluster = cluster.duplicate();
    • Returns the given string.

      • group: connection
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • message: string | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • message: string | Buffer
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Executes a server-side Lua script.

      • group: scripting
      • complexity: Depends on the script that is executed.
      • since: 2.6.0

      Parameters

      • script: string | Buffer
      • numkeys: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            script: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            script: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            script: string
            | Buffer,
            numkeys: string | number,
            ...keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            script: string
            | Buffer,
            numkeys: string | number,
            keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            script: string
            | Buffer,
            numkeys: string | number,
            ...args: RedisValue[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]

      Returns Promise<unknown>

    • Executes a read-only server-side Lua script.

      • group: scripting
      • complexity: Depends on the script that is executed.
      • since: 7.0.0

      Parameters

      • script: string | Buffer
      • numkeys: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            script: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            script: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            script: string
            | Buffer,
            numkeys: string | number,
            ...keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            script: string
            | Buffer,
            numkeys: string | number,
            keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            script: string
            | Buffer,
            numkeys: string | number,
            ...args: RedisValue[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]

      Returns Promise<unknown>

    • Executes a server-side Lua script by SHA1 digest.

      • group: scripting
      • complexity: Depends on the script that is executed.
      • since: 2.6.0

      Parameters

      • sha1: string | Buffer
      • numkeys: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            sha1: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            sha1: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            sha1: string
            | Buffer,
            numkeys: string | number,
            ...keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            sha1: string
            | Buffer,
            numkeys: string | number,
            keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            sha1: string
            | Buffer,
            numkeys: string | number,
            ...args: RedisValue[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]

      Returns Promise<unknown>

    • Executes a read-only server-side Lua script by SHA1 digest.

      • group: scripting
      • complexity: Depends on the script that is executed.
      • since: 7.0.0

      Parameters

      • sha1: string | Buffer
      • numkeys: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            sha1: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            sha1: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            sha1: string
            | Buffer,
            numkeys: string | number,
            ...keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            sha1: string
            | Buffer,
            numkeys: string | number,
            keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            sha1: string
            | Buffer,
            numkeys: string | number,
            ...args: RedisValue[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]

      Returns Promise<unknown>

    • Executes all commands in a transaction.

      • group: transactions
      • complexity: Depends on commands in the transaction
      • since: 1.2.0

      Parameters

      • Optionalcallback: Callback<[error: Error, result: unknown][]>

      Returns Promise<[error: Error, result: unknown][]>

    • Determines whether one or more keys exist.

      • group: generic
      • complexity: O(N) where N is the number of keys to check.
      • since: 1.0.0

      Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Sets the expiration time of a key in seconds.

      • group: generic
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • seconds: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • seconds: string | number
      • nx: "NX"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • seconds: string | number
      • xx: "XX"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • seconds: string | number
      • gt: "GT"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • seconds: string | number
      • lt: "LT"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Sets the expiration time of a key to a Unix timestamp.

      • group: generic
      • complexity: O(1)
      • since: 1.2.0

      Parameters

      • key: RedisKey
      • unixTimeSeconds: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • unixTimeSeconds: string | number
      • nx: "NX"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • unixTimeSeconds: string | number
      • xx: "XX"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • unixTimeSeconds: string | number
      • gt: "GT"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • unixTimeSeconds: string | number
      • lt: "LT"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the expiration time of a key as a Unix timestamp.

      • group: generic
      • complexity: O(1)
      • since: 7.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Starts a coordinated failover from a server to one of its replicas.

      • group: server
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • millisecondsToken: "TIMEOUT"
      • milliseconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • abort: "ABORT"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • abort: "ABORT"
      • millisecondsToken: "TIMEOUT"
      • milliseconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • targetToken: "TO"
      • host: string | Buffer
      • port: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • targetToken: "TO"
      • host: string | Buffer
      • port: string | number
      • millisecondsToken: "TIMEOUT"
      • milliseconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • targetToken: "TO"
      • host: string | Buffer
      • port: string | number
      • abort: "ABORT"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • targetToken: "TO"
      • host: string | Buffer
      • port: string | number
      • abort: "ABORT"
      • millisecondsToken: "TIMEOUT"
      • milliseconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • targetToken: "TO"
      • host: string | Buffer
      • port: string | number
      • force: "FORCE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • targetToken: "TO"
      • host: string | Buffer
      • port: string | number
      • force: "FORCE"
      • millisecondsToken: "TIMEOUT"
      • milliseconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • targetToken: "TO"
      • host: string | Buffer
      • port: string | number
      • force: "FORCE"
      • abort: "ABORT"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • targetToken: "TO"
      • host: string | Buffer
      • port: string | number
      • force: "FORCE"
      • abort: "ABORT"
      • millisecondsToken: "TIMEOUT"
      • milliseconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Invokes a function.

      • group: scripting
      • complexity: Depends on the function that is executed.
      • since: 7.0.0

      Parameters

      • fun: string | Buffer
      • numkeys: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            fun: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            fun: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            fun: string
            | Buffer,
            numkeys: string | number,
            ...keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            fun: string
            | Buffer,
            numkeys: string | number,
            keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [fun: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [fun: string | Buffer, numkeys: string | number, keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            fun: string
            | Buffer,
            numkeys: string | number,
            ...args: RedisValue[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [fun: string | Buffer, numkeys: string | number, ...args: RedisValue[]]

      Returns Promise<unknown>

    • Invokes a read-only function.

      • group: scripting
      • complexity: Depends on the function that is executed.
      • since: 7.0.0

      Parameters

      • fun: string | Buffer
      • numkeys: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            fun: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            fun: string
            | Buffer,
            numkeys: string | number,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            fun: string
            | Buffer,
            numkeys: string | number,
            ...keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            fun: string
            | Buffer,
            numkeys: string | number,
            keys: RedisKey[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [fun: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [fun: string | Buffer, numkeys: string | number, keys: RedisKey[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            fun: string
            | Buffer,
            numkeys: string | number,
            ...args: RedisValue[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [fun: string | Buffer, numkeys: string | number, ...args: RedisValue[]]

      Returns Promise<unknown>

    • Removes all keys from all databases.

      • group: server
      • complexity: O(N) where N is the total number of keys in all databases
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • async: "ASYNC"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • sync: "SYNC"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Remove all keys from the current database.

      • group: server
      • complexity: O(N) where N is the number of keys in the selected database
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • async: "ASYNC"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • sync: "SYNC"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Adds one or more members to a geospatial index. The key is created if it doesn't exist.

      • group: geo
      • complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set.
      • since: 3.2.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ch: "CH", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, nx: "NX", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, nx: "NX", ch: "CH", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, xx: "XX", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, xx: "XX", ch: "CH", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Returns the distance between two members of a geospatial index.

      • group: geo
      • complexity: O(1)
      • since: 3.2.0

      Parameters

      • key: RedisKey
      • member1: string | number | Buffer
      • member2: string | number | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • member1: string | number | Buffer
      • member2: string | number | Buffer
      • m: "M"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • member1: string | number | Buffer
      • member2: string | number | Buffer
      • km: "KM"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • member1: string | number | Buffer
      • member2: string | number | Buffer
      • ft: "FT"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • member1: string | number | Buffer
      • member2: string | number | Buffer
      • mi: "MI"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • member1: string | number | Buffer
      • member2: string | number | Buffer
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • member1: string | number | Buffer
      • member2: string | number | Buffer
      • m: "M"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • member1: string | number | Buffer
      • member2: string | number | Buffer
      • km: "KM"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • member1: string | number | Buffer
      • member2: string | number | Buffer
      • ft: "FT"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • member1: string | number | Buffer
      • member2: string | number | Buffer
      • mi: "MI"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Returns members from a geospatial index as geohash strings.

      • group: geo
      • complexity: O(1) for each member requested.
      • since: 3.2.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            ...members: (string | number | Buffer)[],
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            members: (string | number | Buffer)[],
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [key: RedisKey, members: (string | number | Buffer)[]]

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            ...members: (string | number | Buffer)[],
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            members: (string | number | Buffer)[],
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [key: RedisKey, members: (string | number | Buffer)[]]

      Returns Promise<Buffer[]>

    • Returns the longitude and latitude of members from a geospatial index.

      • group: geo
      • complexity: O(1) for each member requested.
      • since: 3.2.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<[longitude: string, latitude: string][]>

      Returns Promise<[longitude: string, latitude: string][]>

    • Parameters

      • ...args: [
            key: RedisKey,
            ...members: (string | number | Buffer)[],
            callback: Callback<[longitude: string, latitude: string][]>,
        ]

      Returns Promise<[longitude: string, latitude: string][]>

    • Parameters

      • ...args: [
            key: RedisKey,
            members: (string | number | Buffer)[],
            callback: Callback<[longitude: string, latitude: string][]>,
        ]

      Returns Promise<[longitude: string, latitude: string][]>

    • Parameters

      • ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]

      Returns Promise<[longitude: string, latitude: string][]>

    • Parameters

      • ...args: [key: RedisKey, members: (string | number | Buffer)[]]

      Returns Promise<[longitude: string, latitude: string][]>

    • Queries a geospatial index for members within a distance from a coordinate, optionally stores the result.

      • group: geo
      • complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
      • since: 3.2.0

      Parameters

      • ...args: [
            key: RedisKey,
            longitude: string
            | number,
            latitude: string | number,
            radius: string | number,
            ...args: RedisValue[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            longitude: string
            | number,
            latitude: string | number,
            radius: string | number,
            ...args: RedisValue[],
        ]

      Returns Promise<unknown[]>

    • Returns members from a geospatial index that are within a distance from a coordinate.

      • group: geo
      • complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
      • since: 3.2.10

      Parameters

      • ...args: [
            key: RedisKey,
            longitude: string
            | number,
            latitude: string | number,
            radius: string | number,
            ...args: RedisValue[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            longitude: string
            | number,
            latitude: string | number,
            radius: string | number,
            ...args: RedisValue[],
        ]

      Returns Promise<unknown>

    • Queries a geospatial index for members within a distance from a member, optionally stores the result.

      • group: geo
      • complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
      • since: 3.2.0

      Parameters

      • ...args: [
            key: RedisKey,
            member: string
            | number
            | Buffer,
            radius: string | number,
            ...args: RedisValue[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            member: string
            | number
            | Buffer,
            radius: string | number,
            ...args: RedisValue[],
        ]

      Returns Promise<unknown>

    • Returns members from a geospatial index that are within a distance from a member.

      • group: geo
      • complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
      • since: 3.2.10

      Parameters

      • ...args: [
            key: RedisKey,
            member: string
            | number
            | Buffer,
            radius: string | number,
            ...args: RedisValue[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            member: string
            | number
            | Buffer,
            radius: string | number,
            ...args: RedisValue[],
        ]

      Returns Promise<unknown>

    • Queries a geospatial index for members inside an area of a box or a circle.

      • group: geo
      • complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape
      • since: 6.2.0

      Parameters

      Returns Promise<unknown[]>

    • Parameters

      Returns Promise<unknown[]>

    • Queries a geospatial index for members inside an area of a box or a circle, optionally stores the result.

      • group: geo
      • complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape
      • since: 6.2.0

      Parameters

      • ...args: [
            destination: RedisKey,
            source: RedisKey,
            ...args: RedisValue[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Returns the string value of a key.

      • group: string
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Returns a bit value by offset.

      • group: bitmap
      • complexity: O(1)
      • since: 2.2.0

      Parameters

      • key: RedisKey
      • offset: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Return supported builtin commands

      Returns string[]

    • Returns the string value of a key after deleting the key.

      • group: string
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Returns the string value of a key after setting its expiration time.

      • group: string
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • secondsToken: "EX"
      • seconds: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • persist: "PERSIST"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • secondsToken: "EX"
      • seconds: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • persist: "PERSIST"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Returns a substring of the string stored at a key.

      • group: string
      • complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings.
      • since: 2.4.0

      Parameters

      • key: RedisKey
      • start: string | number
      • end: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • start: string | number
      • end: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Returns the previous string value of a key after setting it to a new value.

      • group: string
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Deletes one or more fields and their values from a hash. Deletes the hash if no fields remain.

      • group: hash
      • complexity: O(N) where N is the number of fields to be removed.
      • since: 2.0.0

      Parameters

      • ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...fields: (string | Buffer)[]]

      Returns Promise<number>

    • Handshakes with the server.

      • group: connection
      • complexity: O(1)
      • since: 6.0.0

      Parameters

      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • protover: string | number
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • protover: string | number
      • clientnameToken: "SETNAME"
      • clientname: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • protover: string | number
      • authToken: "AUTH"
      • username: string | Buffer
      • password: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • protover: string | number
      • authToken: "AUTH"
      • username: string | Buffer
      • password: string | Buffer
      • clientnameToken: "SETNAME"
      • clientname: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Determines whether a field exists in a hash.

      • group: hash
      • complexity: O(1)
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • field: string | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the value of a field in a hash.

      • group: hash
      • complexity: O(1)
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • field: string | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Returns all fields and values in a hash.

      • group: hash
      • complexity: O(N) where N is the size of the hash.
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Record<string, string>>

      Returns Promise<Record<string, string>>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Record<string, Buffer>>

      Returns Promise<Record<string, Buffer>>

    • Parameters

      • key: RedisKey
      • field: string | Buffer
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Increments the integer value of a field in a hash by a number. Uses 0 as initial value if the field doesn't exist.

      • group: hash
      • complexity: O(1)
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • field: string | Buffer
      • increment: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Increments the floating point value of a field by a number. Uses 0 as initial value if the field doesn't exist.

      • group: hash
      • complexity: O(1)
      • since: 2.6.0

      Parameters

      • key: RedisKey
      • field: string | Buffer
      • increment: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • field: string | Buffer
      • increment: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Returns all fields in a hash.

      • group: hash
      • complexity: O(N) where N is the size of the hash.
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns the number of fields in a hash.

      • group: hash
      • complexity: O(1)
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the values of all fields in a hash.

      • group: hash
      • complexity: O(N) where N is the number of fields being requested.
      • since: 2.0.0

      Parameters

      • ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [key: RedisKey, ...fields: (string | Buffer)[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [key: RedisKey, ...fields: (string | Buffer)[]]

      Returns Promise<Buffer[]>

    • Sets the values of multiple fields.

      • group: hash
      • complexity: O(N) where N is the number of fields being set.
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • object: object
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • map: Map<string | number | Buffer, string | number | Buffer>
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [key: RedisKey, ...data: (string | number | Buffer)[], callback: Callback<"OK">]

      Returns Promise<"OK">

    • Parameters

      • ...args: [key: RedisKey, ...data: (string | number | Buffer)[]]

      Returns Promise<"OK">

    • Returns one or more random fields from a hash.

      • group: hash
      • complexity: O(N) where N is the number of fields returned
      • since: 6.2.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string | unknown[]>

      Returns Promise<string | unknown[]>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<string | unknown[]>

      Returns Promise<string | unknown[]>

    • Parameters

      • key: RedisKey
      • count: string | number
      • withvalues: "WITHVALUES"
      • Optionalcallback: Callback<string | unknown[]>

      Returns Promise<string | unknown[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<unknown[] | Buffer>

      Returns Promise<unknown[] | Buffer>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<unknown[] | Buffer>

      Returns Promise<unknown[] | Buffer>

    • Parameters

      • key: RedisKey
      • count: string | number
      • withvalues: "WITHVALUES"
      • Optionalcallback: Callback<unknown[] | Buffer>

      Returns Promise<unknown[] | Buffer>

    • Iterates over fields and values of a hash.

      • group: hash
      • complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
      • since: 2.8.0

      Parameters

      • key: RedisKey
      • cursor: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • novalues: "NOVALUES"
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • novalues: "NOVALUES"
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • novalues: "NOVALUES"
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • novalues: "NOVALUES"
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • novalues: "NOVALUES"
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • novalues: "NOVALUES"
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • novalues: "NOVALUES"
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • novalues: "NOVALUES"
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Creates or modifies the value of a field in a hash.

      • group: hash
      • complexity: O(1) for each field/value pair added, so O(N) to add N field/value pairs when the command is called with multiple field/value pairs.
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • object: object
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • map: Map<string | number | Buffer, string | number | Buffer>
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Sets the value of a field in a hash only when the field doesn't exist.

      • group: hash
      • complexity: O(1)
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • field: string | Buffer
      • value: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the length of the value of a field.

      • group: hash
      • complexity: O(1)
      • since: 3.2.0

      Parameters

      • key: RedisKey
      • field: string | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns all values in a hash.

      • group: hash
      • complexity: O(N) where N is the size of the hash.
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Increments the integer value of a key by one. Uses 0 as initial value if the key doesn't exist.

      • group: string
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Increments the integer value of a key by a number. Uses 0 as initial value if the key doesn't exist.

      • group: string
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • increment: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Increment the floating point value of a key by a number. Uses 0 as initial value if the key doesn't exist.

      • group: string
      • complexity: O(1)
      • since: 2.6.0

      Parameters

      • key: RedisKey
      • increment: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Returns information and statistics about the server.

      • group: server
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • ...args: [...sections: (string | Buffer)[], callback: Callback<string>]

      Returns Promise<string>

    • Parameters

      • ...args: (string | Buffer)[]

      Returns Promise<string>

    • Returns all key names that match a pattern.

      • group: generic
      • complexity: O(N) with N being the number of keys in the database, under the assumption that the key names in the database and the given pattern have limited length.
      • since: 1.0.0

      Parameters

      • pattern: string
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • pattern: string
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns the Unix timestamp of the last successful save to disk.

      • group: server
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns a human-readable latency analysis report.

      • group: server
      • complexity: O(1)
      • since: 2.8.13

      Parameters

      • subcommand: "DOCTOR"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Returns a latency graph for an event.

      • group: server
      • complexity: O(1)
      • since: 2.8.13

      Parameters

      • subcommand: "GRAPH"
      • event: string | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Returns helpful text about the different subcommands.

      • group: server
      • complexity: O(1)
      • since: 2.8.13

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns the cumulative distribution of latencies of a subset or all commands.

      • group: server
      • complexity: O(N) where N is the number of commands with latency information being retrieved.
      • since: 7.0.0

      Parameters

      • subcommand: "HISTOGRAM"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "HISTOGRAM",
            ...commands: (string | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[]]

      Returns Promise<unknown>

    • Returns timestamp-latency samples for an event.

      • group: server
      • complexity: O(1)
      • since: 2.8.13

      Parameters

      • subcommand: "HISTORY"
      • event: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns the latest latency samples for all events.

      • group: server
      • complexity: O(1)
      • since: 2.8.13

      Parameters

      • subcommand: "LATEST"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Resets the latency data for one or more events.

      • group: server
      • complexity: O(1)
      • since: 2.8.13

      Parameters

      • subcommand: "RESET"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • ...args: [
            subcommand: "RESET",
            ...events: (string | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [subcommand: "RESET", ...events: (string | Buffer)[]]

      Returns Promise<number>

    • Finds the longest common substring.

      • group: string
      • complexity: O(N*M) where N and M are the lengths of s1 and s2, respectively
      • since: 7.0.0

      Parameters

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • withmatchlen: "WITHMATCHLEN"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • minMatchLenToken: "MINMATCHLEN"
      • minMatchLen: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • minMatchLenToken: "MINMATCHLEN"
      • minMatchLen: string | number
      • withmatchlen: "WITHMATCHLEN"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • idx: "IDX"
      • withmatchlen: "WITHMATCHLEN"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • idx: "IDX"
      • minMatchLenToken: "MINMATCHLEN"
      • minMatchLen: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • idx: "IDX"
      • minMatchLenToken: "MINMATCHLEN"
      • minMatchLen: string | number
      • withmatchlen: "WITHMATCHLEN"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • len: "LEN"
      • withmatchlen: "WITHMATCHLEN"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • len: "LEN"
      • minMatchLenToken: "MINMATCHLEN"
      • minMatchLen: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • len: "LEN"
      • minMatchLenToken: "MINMATCHLEN"
      • minMatchLen: string | number
      • withmatchlen: "WITHMATCHLEN"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • len: "LEN"
      • idx: "IDX"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • len: "LEN"
      • idx: "IDX"
      • withmatchlen: "WITHMATCHLEN"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • len: "LEN"
      • idx: "IDX"
      • minMatchLenToken: "MINMATCHLEN"
      • minMatchLen: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key1: RedisKey
      • key2: RedisKey
      • len: "LEN"
      • idx: "IDX"
      • minMatchLenToken: "MINMATCHLEN"
      • minMatchLen: string | number
      • withmatchlen: "WITHMATCHLEN"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns an element from a list by its index.

      • group: list
      • complexity: O(N) where N is the number of elements to traverse to get to the element at index. This makes asking for the first or the last element of the list O(1).
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • index: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • index: string | number
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Inserts an element before or after another element in a list.

      • group: list
      • complexity: O(N) where N is the number of elements to traverse before seeing the value pivot. This means that inserting somewhere on the left end on the list (head) can be considered O(1) and inserting somewhere on the right end (tail) is O(N).
      • since: 2.2.0

      Parameters

      • key: RedisKey
      • before: "BEFORE"
      • pivot: string | number | Buffer
      • element: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • after: "AFTER"
      • pivot: string | number | Buffer
      • element: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the length of a list.

      • group: list
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns an element after popping it from one list and pushing it to another. Deletes the list if the last element was moved.

      • group: list
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • source: RedisKey
      • destination: RedisKey
      • left: "LEFT"
      • left1: "LEFT"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • left: "LEFT"
      • right: "RIGHT"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • right: "RIGHT"
      • left: "LEFT"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • right: "RIGHT"
      • right1: "RIGHT"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • left: "LEFT"
      • left1: "LEFT"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • left: "LEFT"
      • right: "RIGHT"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • right: "RIGHT"
      • left: "LEFT"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • source: RedisKey
      • destination: RedisKey
      • right: "RIGHT"
      • right1: "RIGHT"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Returns multiple elements from a list after removing them. Deletes the list if the last element was popped.

      • group: list
      • complexity: O(N+M) where N is the number of provided keys and M is the number of elements returned.
      • since: 7.0.0

      Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            left: "LEFT",
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            left: "LEFT",
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            right: "RIGHT",
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: string, members: string[]]>,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: string, members: string[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            left: "LEFT",
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            left: "LEFT",
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            left: "LEFT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            right: "RIGHT",
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<[key: Buffer, members: Buffer[]]>,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            right: "RIGHT",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<[key: Buffer, members: Buffer[]]>

    • Displays computer art and the server version

      • group: server
      • complexity: undefined
      • since: 5.0.0

      Parameters

      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • versionToken: "VERSION"
      • version: string | number
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Returns the first elements in a list after removing it. Deletes the list if the last element was popped.

      • group: list
      • complexity: O(N) where N is the number of elements returned
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns the index of matching elements in a list.

      • group: list
      • complexity: O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.
      • since: 6.0.6

      Parameters

      • key: RedisKey
      • element: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • element: string | number | Buffer
      • lenToken: "MAXLEN"
      • len: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • element: string | number | Buffer
      • numMatchesToken: "COUNT"
      • numMatches: string | number
      • Optionalcallback: Callback<number[]>

      Returns Promise<number[]>

    • Parameters

      • key: RedisKey
      • element: string | number | Buffer
      • numMatchesToken: "COUNT"
      • numMatches: string | number
      • lenToken: "MAXLEN"
      • len: string | number
      • Optionalcallback: Callback<number[]>

      Returns Promise<number[]>

    • Parameters

      • key: RedisKey
      • element: string | number | Buffer
      • rankToken: "RANK"
      • rank: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • element: string | number | Buffer
      • rankToken: "RANK"
      • rank: string | number
      • lenToken: "MAXLEN"
      • len: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • element: string | number | Buffer
      • rankToken: "RANK"
      • rank: string | number
      • numMatchesToken: "COUNT"
      • numMatches: string | number
      • Optionalcallback: Callback<number[]>

      Returns Promise<number[]>

    • Parameters

      • key: RedisKey
      • element: string | number | Buffer
      • rankToken: "RANK"
      • rank: string | number
      • numMatchesToken: "COUNT"
      • numMatches: string | number
      • lenToken: "MAXLEN"
      • len: string | number
      • Optionalcallback: Callback<number[]>

      Returns Promise<number[]>

    • Prepends one or more elements to a list. Creates the key if it doesn't exist.

      • group: list
      • complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
      • since: 1.0.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...elements: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]

      Returns Promise<number>

    • Prepends one or more elements to a list only when the list exists.

      • group: list
      • complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
      • since: 2.2.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...elements: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]

      Returns Promise<number>

    • Returns a range of elements from a list.

      • group: list
      • complexity: O(S+N) where S is the distance of start offset from HEAD for small lists, from nearest end (HEAD or TAIL) for large lists; and N is the number of elements in the specified range.
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • start: string | number
      • stop: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number
      • stop: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Removes elements from a list. Deletes the list if the last element was removed.

      • group: list
      • complexity: O(N+M) where N is the length of the list and M is the number of elements removed.
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • count: string | number
      • element: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Sets the value of an element in a list by its index.

      • group: list
      • complexity: O(N) where N is the length of the list. Setting either the first or the last element of the list is O(1).
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • index: string | number
      • element: string | number | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Removes elements from both ends a list. Deletes the list if all elements were trimmed.

      • group: list
      • complexity: O(N) where N is the number of elements to be removed by the operation.
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • start: string | number
      • stop: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Outputs a memory problems report.

      • group: server
      • complexity: O(1)
      • since: 4.0.0

      Parameters

      • subcommand: "DOCTOR"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Returns helpful text about the different subcommands.

      • group: server
      • complexity: O(1)
      • since: 4.0.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns the allocator statistics.

      • group: server
      • complexity: Depends on how much memory is allocated, could be slow
      • since: 4.0.0

      Parameters

      • subcommand: "MALLOC-STATS"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Asks the allocator to release memory.

      • group: server
      • complexity: Depends on how much memory is allocated, could be slow
      • since: 4.0.0

      Parameters

      • subcommand: "PURGE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Returns details about memory usage.

      • group: server
      • complexity: O(1)
      • since: 4.0.0

      Parameters

      • subcommand: "STATS"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Estimates the memory usage of a key.

      • group: server
      • complexity: O(N) where N is the number of samples.
      • since: 4.0.0

      Parameters

      • subcommand: "USAGE"
      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • subcommand: "USAGE"
      • key: RedisKey
      • countToken: "SAMPLES"
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Atomically returns the string values of one or more keys.

      • group: string
      • complexity: O(N) where N is the number of keys to retrieve.
      • since: 1.0.0

      Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      Returns Promise<string[]>

    • Parameters

      Returns Promise<string[]>

    • Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      Returns Promise<Buffer[]>

    • Parameters

      Returns Promise<Buffer[]>

    • Atomically transfers a key from one instance to another.

      • group: generic
      • complexity: This command actually executes a DUMP+DEL in the source instance, and a RESTORE in the target instance. See the pages of these commands for time complexity. Also an O(N) data transfer between the two instances is performed.
      • since: 2.6.0

      Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • authToken: "AUTH"
      • auth: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • auth2Token: "AUTH2"
      • username: string | Buffer
      • password: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • replace: "REPLACE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • replace: "REPLACE"
      • authToken: "AUTH"
      • auth: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • replace: "REPLACE"
      • auth2Token: "AUTH2"
      • username: string | Buffer
      • password: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • authToken: "AUTH"
      • auth: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • auth2Token: "AUTH2"
      • username: string | Buffer
      • password: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • replace: "REPLACE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • replace: "REPLACE"
      • authToken: "AUTH"
      • auth: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • key: RedisKey
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • replace: "REPLACE"
      • auth2Token: "AUTH2"
      • username: string | Buffer
      • password: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            key: RedisKey,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • authToken: "AUTH"
      • auth: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • auth2Token: "AUTH2"
      • username: string | Buffer
      • password: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • replace: "REPLACE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • replace: "REPLACE"
      • authToken: "AUTH"
      • auth: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • replace: "REPLACE"
      • auth2Token: "AUTH2"
      • username: string | Buffer
      • password: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • authToken: "AUTH"
      • auth: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • auth2Token: "AUTH2"
      • username: string | Buffer
      • password: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • replace: "REPLACE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • replace: "REPLACE"
      • authToken: "AUTH"
      • auth: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            authToken: "AUTH",
            auth: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • host: string | Buffer
      • port: string | number
      • destinationDb: string | number
      • timeout: string | number
      • copy: "COPY"
      • replace: "REPLACE"
      • auth2Token: "AUTH2"
      • username: string | Buffer
      • password: string | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
            callback: Callback<"OK">,
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            ...keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Parameters

      • ...args: [
            host: string
            | Buffer,
            port: string | number,
            destinationDb: string | number,
            timeout: string | number,
            copy: "COPY",
            replace: "REPLACE",
            auth2Token: "AUTH2",
            username: string | Buffer,
            password: string | Buffer,
            keysToken: "KEYS",
            keys: RedisKey[],
        ]

      Returns Promise<"OK">

    • Returns helpful text about the different subcommands.

      • group: server
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns all loaded modules.

      • group: server
      • complexity: O(N) where N is the number of loaded modules.
      • since: 4.0.0

      Parameters

      • subcommand: "LIST"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Loads a module.

      • group: server
      • complexity: O(1)
      • since: 4.0.0

      Parameters

      • subcommand: "LOAD"
      • path: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LOAD",
            path: string
            | Buffer,
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LOAD",
            path: string
            | Buffer,
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<unknown>

    • Loads a module using extended parameters.

      • group: server
      • complexity: O(1)
      • since: 7.0.0

      Parameters

      • subcommand: "LOADEX"
      • path: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LOADEX",
            path: string
            | Buffer,
            argsToken: "ARGS",
            ...args: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LOADEX",
            path: string
            | Buffer,
            argsToken: "ARGS",
            ...args: (string | number | Buffer)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LOADEX",
            path: string
            | Buffer,
            configsToken: "CONFIG",
            ...configs: (string | number | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LOADEX",
            path: string
            | Buffer,
            configsToken: "CONFIG",
            ...configs: (string | number | Buffer)[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LOADEX",
            path: string
            | Buffer,
            configsToken: "CONFIG",
            ...args: RedisValue[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            subcommand: "LOADEX",
            path: string
            | Buffer,
            configsToken: "CONFIG",
            ...args: RedisValue[],
        ]

      Returns Promise<unknown>

    • Unloads a module.

      • group: server
      • complexity: O(1)
      • since: 4.0.0

      Parameters

      • subcommand: "UNLOAD"
      • name: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Moves a key to another database.

      • group: generic
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • db: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Atomically creates or modifies the string values of one or more keys.

      • group: string
      • complexity: O(N) where N is the number of keys to set.
      • since: 1.0.1

      Parameters

      • object: object
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • map: Map<string | number | Buffer, string | number | Buffer>
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [...data: (number | RedisKey)[], callback: Callback<"OK">]

      Returns Promise<"OK">

    • Parameters

      Returns Promise<"OK">

    • Atomically modifies the string values of one or more keys only when all keys don't exist.

      • group: string
      • complexity: O(N) where N is the number of keys to set.
      • since: 1.0.1

      Parameters

      • object: object
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • map: Map<string | number | Buffer, string | number | Buffer>
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [...data: (number | RedisKey)[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Returns the internal encoding of an object.

      • group: generic
      • complexity: O(1)
      • since: 2.2.3

      Parameters

      • subcommand: "ENCODING"
      • key: RedisKey
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the logarithmic access frequency counter of an object.

      • group: generic
      • complexity: O(1)
      • since: 4.0.0

      Parameters

      • subcommand: "FREQ"
      • key: RedisKey
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns helpful text about the different subcommands.

      • group: generic
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the time since the last access to an object.

      • group: generic
      • complexity: O(1)
      • since: 2.2.3

      Parameters

      • subcommand: "IDLETIME"
      • key: RedisKey
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the reference count of a value of a key.

      • group: generic
      • complexity: O(1)
      • since: 2.2.3

      Parameters

      • subcommand: "REFCOUNT"
      • key: RedisKey
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Removes the expiration time of a key.

      • group: generic
      • complexity: O(1)
      • since: 2.2.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Sets the expiration time of a key in milliseconds.

      • group: generic
      • complexity: O(1)
      • since: 2.6.0

      Parameters

      • key: RedisKey
      • milliseconds: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • milliseconds: string | number
      • nx: "NX"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • milliseconds: string | number
      • xx: "XX"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • milliseconds: string | number
      • gt: "GT"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • milliseconds: string | number
      • lt: "LT"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Sets the expiration time of a key to a Unix milliseconds timestamp.

      • group: generic
      • complexity: O(1)
      • since: 2.6.0

      Parameters

      • key: RedisKey
      • unixTimeMilliseconds: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • unixTimeMilliseconds: string | number
      • nx: "NX"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • unixTimeMilliseconds: string | number
      • xx: "XX"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • unixTimeMilliseconds: string | number
      • gt: "GT"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • unixTimeMilliseconds: string | number
      • lt: "LT"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the expiration time of a key as a Unix milliseconds timestamp.

      • group: generic
      • complexity: O(1)
      • since: 7.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Adds elements to a HyperLogLog key. Creates the key if it doesn't exist.

      • group: hyperloglog
      • complexity: O(1) to add every element.
      • since: 2.8.9

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            ...elements: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]

      Returns Promise<number>

    • Returns the approximated cardinality of the set(s) observed by the HyperLogLog key(s).

      • group: hyperloglog
      • complexity: O(1) with a very small average constant time when called with a single key. O(N) with N being the number of keys, and much bigger constant times, when called with multiple keys.
      • since: 2.8.9

      Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Internal commands for debugging HyperLogLog values.

      • group: hyperloglog
      • complexity: N/A
      • since: 2.8.9

      Parameters

      • subcommand: string | Buffer
      • key: RedisKey
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Merges one or more HyperLogLog values into a single key.

      • group: hyperloglog
      • complexity: O(N) to merge N HyperLogLogs, but with high constant times.
      • since: 2.8.9

      Parameters

      • destkey: RedisKey
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • ...args: [destkey: RedisKey, ...sourcekeys: RedisKey[], callback: Callback<"OK">]

      Returns Promise<"OK">

    • Parameters

      Returns Promise<"OK">

    • Parameters

      Returns Promise<"OK">

    • Parameters

      Returns Promise<"OK">

    • An internal command for testing HyperLogLog values.

      • group: hyperloglog
      • complexity: N/A
      • since: 2.8.9

      Parameters

      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the server's liveliness response.

      • group: connection
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<"PONG">

      Returns Promise<"PONG">

    • Parameters

      • message: string | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • message: string | Buffer
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Sets both string value and expiration time in milliseconds of a key. The key is created if it doesn't exist.

      • group: string
      • complexity: O(1)
      • since: 2.6.0

      Parameters

      • key: RedisKey
      • milliseconds: string | number
      • value: string | number | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Listens for messages published to channels that match one or more patterns.

      • group: pubsub
      • complexity: O(N) where N is the number of patterns to subscribe to.
      • since: 2.0.0

      Parameters

      • ...args: [...patterns: string[], callback: Callback<unknown>]

      Returns Promise<unknown>

    • Parameters

      • ...args: string[]

      Returns Promise<unknown>

    • An internal command used in replication.

      • group: server
      • complexity: undefined
      • since: 2.8.0

      Parameters

      • replicationid: string | number | Buffer
      • offset: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the expiration time in milliseconds of a key.

      • group: generic
      • complexity: O(1)
      • since: 2.6.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Posts a message to a channel.

      • group: pubsub
      • complexity: O(N+M) where N is the number of clients subscribed to the receiving channel and M is the total number of subscribed patterns (by any client).
      • since: 2.0.0

      Parameters

      • channel: string | Buffer
      • message: string | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the active channels.

      • group: pubsub
      • complexity: O(N) where N is the number of active channels, and assuming constant time pattern matching (relatively short channels and patterns)
      • since: 2.8.0

      Parameters

      • subcommand: "CHANNELS"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • subcommand: "CHANNELS"
      • pattern: string
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns helpful text about the different subcommands.

      • group: pubsub
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns a count of unique pattern subscriptions.

      • group: pubsub
      • complexity: O(1)
      • since: 2.8.0

      Parameters

      • subcommand: "NUMPAT"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns a count of subscribers to channels.

      • group: pubsub
      • complexity: O(N) for the NUMSUB subcommand, where N is the number of requested channels
      • since: 2.8.0

      Parameters

      • subcommand: "NUMSUB"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            subcommand: "NUMSUB",
            ...channels: (string | Buffer)[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[]]

      Returns Promise<unknown[]>

    • Returns the active shard channels.

      • group: pubsub
      • complexity: O(N) where N is the number of active shard channels, and assuming constant time pattern matching (relatively short shard channels).
      • since: 7.0.0

      Parameters

      • subcommand: "SHARDCHANNELS"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • subcommand: "SHARDCHANNELS"
      • pattern: string
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns the count of subscribers of shard channels.

      • group: pubsub
      • complexity: O(N) for the SHARDNUMSUB subcommand, where N is the number of requested shard channels
      • since: 7.0.0

      Parameters

      • subcommand: "SHARDNUMSUB"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            subcommand: "SHARDNUMSUB",
            ...shardchannels: (string | Buffer)[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[]]

      Returns Promise<unknown[]>

    • Stops listening to messages published to channels that match one or more patterns.

      • group: pubsub
      • complexity: O(N) where N is the number of patterns to unsubscribe.
      • since: 2.0.0

      Parameters

      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [...patterns: string[], callback: Callback<unknown>]

      Returns Promise<unknown>

    • Parameters

      • ...args: string[]

      Returns Promise<unknown>

    • Quit the cluster gracefully.

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Returns a random key name from the database.

      • group: generic
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Enables read-only queries for a connection to a Valkey replica node.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Enables read-write queries for a connection to a Valkey replica node.

      • group: cluster
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Renames a key and overwrites the destination.

      • group: generic
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      Returns Promise<"OK">

    • Renames a key only when the target key name doesn't exist.

      • group: generic
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      Returns Promise<number>

    • An internal command for configuring the replication stream.

      • group: server
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Configures a server as replica of another, or promotes it to a primary.

      • group: server
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • host: string | Buffer
      • port: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • no: "NO"
      • one: "ONE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Resets the connection.

      • group: connection
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Creates a key from the serialized representation of a value.

      • group: generic
      • complexity: O(1) to create the new key and additional O(NM) to reconstruct the serialized value, where N is the number of objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)).
      • since: 2.6.0

      Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • absttl: "ABSTTL"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • absttl: "ABSTTL"
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • absttl: "ABSTTL"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • absttl: "ABSTTL"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • absttl: "ABSTTL"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • absttl: "ABSTTL"
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • absttl: "ABSTTL"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • absttl: "ABSTTL"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • An internal command for migrating keys in a cluster.

      • group: server
      • complexity: O(1) to create the new key and additional O(NM) to reconstruct the serialized value, where N is the number of objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)).
      • since: 3.0.0

      Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • absttl: "ABSTTL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • absttl: "ABSTTL"
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • absttl: "ABSTTL"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • absttl: "ABSTTL"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • absttl: "ABSTTL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • absttl: "ABSTTL"
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • absttl: "ABSTTL"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • ttl: string | number
      • serializedValue: string | number | Buffer
      • replace: "REPLACE"
      • absttl: "ABSTTL"
      • secondsToken: "IDLETIME"
      • seconds: string | number
      • frequencyToken: "FREQ"
      • frequency: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the replication role.

      • group: server
      • complexity: O(1)
      • since: 2.8.12

      Parameters

      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns and removes the last elements of a list. Deletes the list if the last element was popped.

      • group: list
      • complexity: O(N) where N is the number of elements returned
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns the last element of a list after removing and pushing it to another list. Deletes the list if the last element was popped.

      • group: list
      • complexity: O(1)
      • since: 1.2.0

      Parameters

      Returns Promise<string>

    • Parameters

      Returns Promise<Buffer>

    • Appends one or more elements to a list. Creates the key if it doesn't exist.

      • group: list
      • complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
      • since: 1.0.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...elements: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]

      Returns Promise<number>

    • Appends an element to a list only when the list exists.

      • group: list
      • complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
      • since: 2.2.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...elements: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]

      Returns Promise<number>

    • Adds one or more members to a set. Creates the key if it doesn't exist.

      • group: set
      • complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
      • since: 1.0.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...members: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            members: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, members: (string | number | Buffer)[]]

      Returns Promise<number>

    • Synchronously saves the database(s) to disk.

      • group: server
      • complexity: O(N) where N is the total number of keys in all databases
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Iterates over the key names in the database.

      • group: generic
      • complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
      • since: 2.8.0

      Parameters

      • cursor: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • cursor: string | number
      • typeToken: "TYPE"
      • type: string | Buffer
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • typeToken: "TYPE"
      • type: string | Buffer
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • typeToken: "TYPE"
      • type: string | Buffer
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • typeToken: "TYPE"
      • type: string | Buffer
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • cursor: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • cursor: string | number
      • typeToken: "TYPE"
      • type: string | Buffer
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • typeToken: "TYPE"
      • type: string | Buffer
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • typeToken: "TYPE"
      • type: string | Buffer
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • typeToken: "TYPE"
      • type: string | Buffer
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Returns the number of members in a set.

      • group: set
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Sets the debug mode of server-side Lua scripts.

      • group: scripting
      • complexity: O(1)
      • since: 3.2.0

      Parameters

      • subcommand: "DEBUG"
      • yes: "YES"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "DEBUG"
      • sync: "SYNC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "DEBUG"
      • no: "NO"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Determines whether server-side Lua scripts exist in the script cache.

      • group: scripting
      • complexity: O(N) with N being the number of scripts to check (so checking a single script is an O(1) operation).
      • since: 2.6.0

      Parameters

      • ...args: [
            subcommand: "EXISTS",
            ...sha1s: (string | Buffer)[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[]]

      Returns Promise<unknown>

    • Removes all server-side Lua scripts from the script cache.

      • group: scripting
      • complexity: O(N) with N being the number of scripts in cache
      • since: 2.6.0

      Parameters

      • subcommand: "FLUSH"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "FLUSH"
      • async: "ASYNC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "FLUSH"
      • sync: "SYNC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns helpful text about the different subcommands.

      • group: scripting
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Terminates a server-side Lua script during execution.

      • group: scripting
      • complexity: O(1)
      • since: 2.6.0

      Parameters

      • subcommand: "KILL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Loads a server-side Lua script to the script cache.

      • group: scripting
      • complexity: O(N) with N being the length in bytes of the script body.
      • since: 2.6.0

      Parameters

      • subcommand: "LOAD"
      • script: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Show server-side Lua script in the script cache.

      • group: scripting
      • complexity: O(1).
      • since: 8.0.0

      Parameters

      • subcommand: "SHOW"
      • sha1: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the difference of multiple sets.

      • group: set
      • complexity: O(N) where N is the total number of elements in all given sets.
      • since: 1.0.0

      Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      Returns Promise<string[]>

    • Parameters

      Returns Promise<string[]>

    • Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      Returns Promise<Buffer[]>

    • Parameters

      Returns Promise<Buffer[]>

    • Stores the difference of multiple sets in a key.

      • group: set
      • complexity: O(N) where N is the total number of elements in all given sets.
      • since: 1.0.0

      Parameters

      • ...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Changes the selected database.

      • group: connection
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • index: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Sets the string value of a key, ignoring its type. The key is created if it doesn't exist.

      • group: string
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • nx: "NX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • xx: "XX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • secondsToken: "EX"
      • seconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • secondsToken: "EX"
      • seconds: string | number
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • secondsToken: "EX"
      • seconds: string | number
      • nx: "NX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • secondsToken: "EX"
      • seconds: string | number
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • secondsToken: "EX"
      • seconds: string | number
      • xx: "XX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • secondsToken: "EX"
      • seconds: string | number
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • nx: "NX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • xx: "XX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • nx: "NX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • xx: "XX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • nx: "NX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • xx: "XX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • keepttl: "KEEPTTL"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • keepttl: "KEEPTTL"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • keepttl: "KEEPTTL"
      • nx: "NX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • keepttl: "KEEPTTL"
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • keepttl: "KEEPTTL"
      • xx: "XX"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • keepttl: "KEEPTTL"
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Sets or clears the bit at offset of the string value. Creates the key if it doesn't exist.

      • group: bitmap
      • complexity: O(1)
      • since: 2.2.0

      Parameters

      • key: RedisKey
      • offset: string | number
      • value: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • secondsToken: "EX"
      • seconds: string | number
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • secondsToken: "EX"
      • seconds: string | number
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • secondsToken: "EX"
      • seconds: string | number
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • millisecondsToken: "PX"
      • milliseconds: string | number
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeSecondsToken: "EXAT"
      • unixTimeSeconds: string | number
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • unixTimeMillisecondsToken: "PXAT"
      • unixTimeMilliseconds: string | number
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • keepttl: "KEEPTTL"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • keepttl: "KEEPTTL"
      • nx: "NX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • keepttl: "KEEPTTL"
      • xx: "XX"
      • get: "GET"
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Sets the string value and expiration time of a key. Creates the key if it doesn't exist.

      • group: string
      • complexity: O(1)
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • seconds: string | number
      • value: string | number | Buffer
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Set the string value of a key only when the key doesn't exist.

      • group: string
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • value: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Overwrites a part of a string value with another by an offset. Creates the key if it doesn't exist.

      • group: string
      • complexity: O(1), not counting the time taken to copy the new string in place. Usually, this string is very small so the amortized complexity is O(1). Otherwise, complexity is O(M) with M being the length of the value argument.
      • since: 2.2.0

      Parameters

      • key: RedisKey
      • offset: string | number
      • value: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Synchronously saves the database(s) to disk and shuts down the server.

      • group: server
      • complexity: O(N) when saving, where N is the total number of keys in all databases when saving data, otherwise O(1)
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • force: "FORCE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • now: "NOW"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • now: "NOW"
      • force: "FORCE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • nosave: "NOSAVE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • nosave: "NOSAVE"
      • force: "FORCE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • nosave: "NOSAVE"
      • now: "NOW"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • nosave: "NOSAVE"
      • now: "NOW"
      • force: "FORCE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • save: "SAVE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • save: "SAVE"
      • force: "FORCE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • save: "SAVE"
      • now: "NOW"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • save: "SAVE"
      • now: "NOW"
      • force: "FORCE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • abort: "ABORT"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Returns the intersect of multiple sets.

      • group: set
      • complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.
      • since: 1.0.0

      Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      Returns Promise<string[]>

    • Parameters

      Returns Promise<string[]>

    • Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      Returns Promise<Buffer[]>

    • Parameters

      Returns Promise<Buffer[]>

    • Returns the number of members of the intersect of multiple sets.

      • group: set
      • complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.
      • since: 7.0.0

      Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<number>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            limitToken: "LIMIT",
            limit: string | number,
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            limitToken: "LIMIT",
            limit: string | number,
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            limitToken: "LIMIT",
            limit: string | number,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            limitToken: "LIMIT",
            limit: string | number,
        ]

      Returns Promise<number>

    • Stores the intersect of multiple sets in a key.

      • group: set
      • complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.
      • since: 1.0.0

      Parameters

      • ...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Determines whether a member belongs to a set.

      • group: set
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • member: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Sets a server as a replica of another, or promotes it to being a primary.

      • group: server
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • host: string | Buffer
      • port: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Parameters

      • no: "NO"
      • one: "ONE"
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Returns the slow log's entries.

      • group: server
      • complexity: O(N) where N is the number of entries returned
      • since: 2.2.12

      Parameters

      • subcommand: "GET"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "GET"
      • count: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Show helpful text about the different subcommands

      • group: server
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the number of entries in the slow log.

      • group: server
      • complexity: O(1)
      • since: 2.2.12

      Parameters

      • subcommand: "LEN"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Clears all entries from the slow log.

      • group: server
      • complexity: O(N) where N is the number of entries in the slowlog
      • since: 2.2.12

      Parameters

      • subcommand: "RESET"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns all members of a set.

      • group: set
      • complexity: O(N) where N is the set cardinality.
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Determines whether multiple members belong to a set.

      • group: set
      • complexity: O(N) where N is the number of elements being checked for membership
      • since: 6.2.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...members: (string | number | Buffer)[],
            callback: Callback<number[]>,
        ]

      Returns Promise<number[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            members: (string | number | Buffer)[],
            callback: Callback<number[]>,
        ]

      Returns Promise<number[]>

    • Parameters

      • ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]

      Returns Promise<number[]>

    • Parameters

      • ...args: [key: RedisKey, members: (string | number | Buffer)[]]

      Returns Promise<number[]>

    • Moves a member from one set to another.

      • group: set
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • source: RedisKey
      • destination: RedisKey
      • member: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Sorts the elements in a list, a set, or a sorted set, optionally storing the result.

      • group: generic
      • complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N).
      • since: 1.0.0

      Parameters

      Returns Promise<unknown>

    • Parameters

      Returns Promise<unknown>

    • Returns the sorted elements of a list, a set, or a sorted set.

      • group: generic
      • complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N).
      • since: 7.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • asc: "ASC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • asc: "ASC"
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • desc: "DESC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • desc: "DESC"
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            getPatternToken: "GET",
            ...getPatterns: string[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [key: RedisKey, getPatternToken: "GET", ...getPatterns: string[]]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            getPatternToken: "GET",
            ...getPatterns: string[],
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            getPatternToken: "GET",
            ...getPatterns: string[],
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [key: RedisKey, getPatternToken: "GET", ...getPatterns: string[], asc: "ASC"]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [key: RedisKey, getPatternToken: "GET", ...getPatterns: string[], desc: "DESC"]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • asc: "ASC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • asc: "ASC"
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • desc: "DESC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • desc: "DESC"
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • asc: "ASC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • asc: "ASC"
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • desc: "DESC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • desc: "DESC"
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • asc: "ASC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • asc: "ASC"
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • desc: "DESC"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • byPatternToken: "BY"
      • byPattern: string
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • desc: "DESC"
      • alpha: "ALPHA"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            asc: "ASC",
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            alpha: "ALPHA",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            key: RedisKey,
            byPatternToken: "BY",
            byPattern: string,
            limitToken: "LIMIT",
            offset: string
            | number,
            count: string | number,
            getPatternToken: "GET",
            ...getPatterns: string[],
            desc: "DESC",
            alpha: "ALPHA",
        ]

      Returns Promise<unknown>

    • Returns one or more random members from a set after removing them. Deletes the set if the last member was popped.

      • group: set
      • complexity: Without the count argument O(1), otherwise O(N) where N is the value of the passed count.
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Post a message to a shard channel

      • group: pubsub
      • complexity: O(N) where N is the number of clients subscribed to the receiving shard channel.
      • since: 7.0.0

      Parameters

      • shardchannel: string | Buffer
      • message: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Get one or multiple random members from a set

      • group: set
      • complexity: Without the count argument O(1), otherwise O(N) where N is the absolute value of the passed count.
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Removes one or more members from a set. Deletes the set if the last member was removed.

      • group: set
      • complexity: O(N) where N is the number of members to be removed.
      • since: 1.0.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...members: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            members: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, members: (string | number | Buffer)[]]

      Returns Promise<number>

    • Iterates over members of a set.

      • group: set
      • complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
      • since: 2.8.0

      Parameters

      • key: RedisKey
      • cursor: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Listens for messages published to shard channels.

      • group: pubsub
      • complexity: O(N) where N is the number of shard channels to subscribe to.
      • since: 7.0.0

      Parameters

      • ...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]

      Returns Promise<unknown>

    • Parameters

      • ...args: (string | Buffer)[]

      Returns Promise<unknown>

    • Returns the length of a string value.

      • group: string
      • complexity: O(1)
      • since: 2.2.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Listens for messages published to channels.

      • group: pubsub
      • complexity: O(N) where N is the number of channels to subscribe to.
      • since: 2.0.0

      Parameters

      • ...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]

      Returns Promise<unknown>

    • Parameters

      • ...args: (string | Buffer)[]

      Returns Promise<unknown>

    • Returns a substring from a string value.

      • group: string
      • complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings.
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • start: string | number
      • end: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the union of multiple sets.

      • group: set
      • complexity: O(N) where N is the total number of elements in all given sets.
      • since: 1.0.0

      Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      Returns Promise<string[]>

    • Parameters

      Returns Promise<string[]>

    • Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      Returns Promise<Buffer[]>

    • Parameters

      Returns Promise<Buffer[]>

    • Stores the union of multiple sets in a key.

      • group: set
      • complexity: O(N) where N is the total number of elements in all given sets.
      • since: 1.0.0

      Parameters

      • ...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Stops listening to messages posted to shard channels.

      • group: pubsub
      • complexity: O(N) where N is the number of shard channels to unsubscribe.
      • since: 7.0.0

      Parameters

      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]

      Returns Promise<unknown>

    • Parameters

      • ...args: (string | Buffer)[]

      Returns Promise<unknown>

    • Swaps two databases.

      • group: server
      • complexity: O(N) where N is the count of clients watching or blocking on keys from both databases.
      • since: 4.0.0

      Parameters

      • index1: string | number
      • index2: string | number
      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • An internal command used in replication.

      • group: server
      • complexity: undefined
      • since: 1.0.0

      Parameters

      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns the server time.

      • group: server
      • complexity: O(1)
      • since: 2.6.0

      Parameters

      • Optionalcallback: Callback<number[]>

      Returns Promise<number[]>

    • Returns the number of existing keys out of those specified after updating the time they were last accessed.

      • group: generic
      • complexity: O(N) where N is the number of keys that will be touched.
      • since: 3.2.1

      Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Returns the expiration time in seconds of a key.

      • group: generic
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Determines the type of value stored at a key.

      • group: generic
      • complexity: O(1)
      • since: 1.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Asynchronously deletes one or more keys.

      • group: generic
      • complexity: O(1) for each key removed regardless of its size. Then the command does O(N) work in a different thread in order to reclaim memory, where N is the number of allocations the deleted objects where composed of.
      • since: 4.0.0

      Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Stops listening to messages posted to channels.

      • group: pubsub
      • complexity: O(N) where N is the number of channels to unsubscribe.
      • since: 2.0.0

      Parameters

      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • ...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]

      Returns Promise<unknown>

    • Parameters

      • ...args: (string | Buffer)[]

      Returns Promise<unknown>

    • Forgets about watched keys of a transaction.

      • group: transactions
      • complexity: O(1)
      • since: 2.2.0

      Parameters

      • Optionalcallback: Callback<"OK">

      Returns Promise<"OK">

    • Blocks until the asynchronous replication of all preceding write commands sent by the connection is completed.

      • group: generic
      • complexity: O(1)
      • since: 3.0.0

      Parameters

      • numreplicas: string | number
      • timeout: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Blocks until all of the preceding write commands sent by the connection are written to the append-only file of the primary and/or replicas.

      • group: generic
      • complexity: O(1)
      • since: 7.2.0

      Parameters

      • numlocal: string | number
      • numreplicas: string | number
      • timeout: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Monitors changes to keys to determine the execution of a transaction.

      • group: transactions
      • complexity: O(1) for every key.
      • since: 2.2.0

      Parameters

      • ...args: [...keys: RedisKey[], callback: Callback<"OK">]

      Returns Promise<"OK">

    • Parameters

      • ...args: [keys: RedisKey[], callback: Callback<"OK">]

      Returns Promise<"OK">

    • Parameters

      Returns Promise<"OK">

    • Parameters

      Returns Promise<"OK">

    • Returns the number of messages that were successfully acknowledged by the consumer group member of a stream.

      • group: stream
      • complexity: O(1) for each message ID processed.
      • since: 5.0.0

      Parameters

      • ...args: [
            key: RedisKey,
            group: string
            | Buffer,
            ...ids: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[]]

      Returns Promise<number>

    • Appends a new message to a stream. Creates the key if it doesn't exist.

      • group: stream
      • complexity: O(1) when adding a new entry, O(N) when trimming where N being the number of entries evicted.
      • since: 5.0.0

      Parameters

      Returns Promise<string>

    • Parameters

      Returns Promise<string>

    • Changes, or acquires, ownership of messages in a consumer group, as if the messages were delivered to as consumer group member.

      • group: stream
      • complexity: O(1) if COUNT is small.
      • since: 6.2.0

      Parameters

      • key: RedisKey
      • group: string | Buffer
      • consumer: string | Buffer
      • minIdleTime: string | number | Buffer
      • start: string | number | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • key: RedisKey
      • group: string | Buffer
      • consumer: string | Buffer
      • minIdleTime: string | number | Buffer
      • start: string | number | Buffer
      • justid: "JUSTID"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • key: RedisKey
      • group: string | Buffer
      • consumer: string | Buffer
      • minIdleTime: string | number | Buffer
      • start: string | number | Buffer
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • key: RedisKey
      • group: string | Buffer
      • consumer: string | Buffer
      • minIdleTime: string | number | Buffer
      • start: string | number | Buffer
      • countToken: "COUNT"
      • count: string | number
      • justid: "JUSTID"
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Changes, or acquires, ownership of a message in a consumer group, as if the message was delivered a consumer group member.

      • group: stream
      • complexity: O(log N) with N being the number of messages in the PEL of the consumer group.
      • since: 5.0.0

      Parameters

      • ...args: [
            key: RedisKey,
            group: string
            | Buffer,
            consumer: string | Buffer,
            minIdleTime: string | number | Buffer,
            ...args: RedisValue[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            group: string
            | Buffer,
            consumer: string | Buffer,
            minIdleTime: string | number | Buffer,
            ...args: RedisValue[],
        ]

      Returns Promise<unknown[]>

    • Returns the number of messages after removing them from a stream.

      • group: stream
      • complexity: O(1) for each single item to delete in the stream, regardless of the stream size.
      • since: 5.0.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...ids: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...ids: (string | number | Buffer)[]]

      Returns Promise<number>

    • Creates a consumer group.

      • group: stream
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "CREATE"
      • key: RedisKey
      • group: string | Buffer
      • id: string | number | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "CREATE"
      • key: RedisKey
      • group: string | Buffer
      • id: string | number | Buffer
      • entriesreadToken: "ENTRIESREAD"
      • entriesread: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "CREATE"
      • key: RedisKey
      • group: string | Buffer
      • id: string | number | Buffer
      • mkstream: "MKSTREAM"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "CREATE"
      • key: RedisKey
      • group: string | Buffer
      • id: string | number | Buffer
      • mkstream: "MKSTREAM"
      • entriesreadToken: "ENTRIESREAD"
      • entriesread: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "CREATE"
      • key: RedisKey
      • group: string | Buffer
      • newId: "$"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "CREATE"
      • key: RedisKey
      • group: string | Buffer
      • newId: "$"
      • entriesreadToken: "ENTRIESREAD"
      • entriesread: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "CREATE"
      • key: RedisKey
      • group: string | Buffer
      • newId: "$"
      • mkstream: "MKSTREAM"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "CREATE"
      • key: RedisKey
      • group: string | Buffer
      • newId: "$"
      • mkstream: "MKSTREAM"
      • entriesreadToken: "ENTRIESREAD"
      • entriesread: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Creates a consumer in a consumer group.

      • group: stream
      • complexity: O(1)
      • since: 6.2.0

      Parameters

      • subcommand: "CREATECONSUMER"
      • key: RedisKey
      • group: string | Buffer
      • consumer: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Deletes a consumer from a consumer group.

      • group: stream
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "DELCONSUMER"
      • key: RedisKey
      • group: string | Buffer
      • consumer: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Destroys a consumer group.

      • group: stream
      • complexity: O(N) where N is the number of entries in the group's pending entries list (PEL).
      • since: 5.0.0

      Parameters

      • subcommand: "DESTROY"
      • key: RedisKey
      • group: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns helpful text about the different subcommands.

      • group: stream
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Sets the last-delivered ID of a consumer group.

      • group: stream
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "SETID"
      • key: RedisKey
      • group: string | Buffer
      • id: string | number | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "SETID"
      • key: RedisKey
      • group: string | Buffer
      • id: string | number | Buffer
      • entriesreadToken: "ENTRIESREAD"
      • entriesread: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "SETID"
      • key: RedisKey
      • group: string | Buffer
      • newId: "$"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "SETID"
      • key: RedisKey
      • group: string | Buffer
      • newId: "$"
      • entriesreadToken: "ENTRIESREAD"
      • entriesread: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns a list of the consumers in a consumer group.

      • group: stream
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "CONSUMERS"
      • key: RedisKey
      • group: string | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns a list of the consumer groups of a stream.

      • group: stream
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "GROUPS"
      • key: RedisKey
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns helpful text about the different subcommands.

      • group: stream
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "HELP"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Returns information about a stream.

      • group: stream
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • subcommand: "STREAM"
      • key: RedisKey
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "STREAM"
      • key: RedisKey
      • full: "FULL"
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • subcommand: "STREAM"
      • key: RedisKey
      • full: "FULL"
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Return the number of messages in a stream.

      • group: stream
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the information and entries from a stream consumer group's pending entries list.

      • group: stream
      • complexity: O(N) with N being the number of elements returned, so asking for a small fixed number of entries per call is O(1). O(M), where M is the total number of entries scanned when used with the IDLE filter. When the command returns just the summary and the list of consumers is small, it runs in O(1) time; otherwise, an additional O(N) time for iterating every consumer.
      • since: 5.0.0

      Parameters

      • key: RedisKey
      • group: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • key: RedisKey
      • group: string | Buffer
      • start: string | number | Buffer
      • end: string | number | Buffer
      • count: string | number
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • key: RedisKey
      • group: string | Buffer
      • start: string | number | Buffer
      • end: string | number | Buffer
      • count: string | number
      • consumer: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • key: RedisKey
      • group: string | Buffer
      • minIdleTimeToken: "IDLE"
      • minIdleTime: string | number
      • start: string | number | Buffer
      • end: string | number | Buffer
      • count: string | number
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Parameters

      • key: RedisKey
      • group: string | Buffer
      • minIdleTimeToken: "IDLE"
      • minIdleTime: string | number
      • start: string | number | Buffer
      • end: string | number | Buffer
      • count: string | number
      • consumer: string | Buffer
      • Optionalcallback: Callback<unknown[]>

      Returns Promise<unknown[]>

    • Returns the messages from a stream within a range of IDs.

      • group: stream
      • complexity: O(N) with N being the number of elements being returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1).
      • since: 5.0.0

      Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • end: string | number | Buffer
      • Optionalcallback: Callback<[id: string, fields: string[]][]>

      Returns Promise<[id: string, fields: string[]][]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • end: string | number | Buffer
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[id: string, fields: string[]][]>

      Returns Promise<[id: string, fields: string[]][]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • end: string | number | Buffer
      • Optionalcallback: Callback<[id: Buffer, fields: Buffer[]][]>

      Returns Promise<[id: Buffer, fields: Buffer[]][]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • end: string | number | Buffer
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[id: Buffer, fields: Buffer[]][]>

      Returns Promise<[id: Buffer, fields: Buffer[]][]>

    • Returns messages from multiple streams with IDs greater than the ones requested. Blocks until a message is available otherwise.

      • group: stream
      • complexity: undefined
      • since: 5.0.0

      Parameters

      • ...args: [
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<
                [key: string, items: [id: string, fields: string[]][]][],
            >,
        ]

      Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>

    • Parameters

      • ...args: [streamsToken: "STREAMS", ...args: RedisValue[]]

      Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>

    • Parameters

      • ...args: [
            millisecondsToken: "BLOCK",
            milliseconds: string
            | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<
                [key: string, items: [id: string, fields: string[]][]][],
            >,
        ]

      Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>

    • Parameters

      • ...args: [
            millisecondsToken: "BLOCK",
            milliseconds: string
            | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>

    • Parameters

      • ...args: [
            countToken: "COUNT",
            count: string
            | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<
                [key: string, items: [id: string, fields: string[]][]][],
            >,
        ]

      Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>

    • Parameters

      • ...args: [
            countToken: "COUNT",
            count: string
            | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>

    • Parameters

      • ...args: [
            countToken: "COUNT",
            count: string
            | number,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<
                [key: string, items: [id: string, fields: string[]][]][],
            >,
        ]

      Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>

    • Parameters

      • ...args: [
            countToken: "COUNT",
            count: string
            | number,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>

    • Parameters

      • ...args: [
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<
                [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
            >,
        ]

      Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>

    • Parameters

      • ...args: [streamsToken: "STREAMS", ...args: RedisValue[]]

      Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>

    • Parameters

      • ...args: [
            millisecondsToken: "BLOCK",
            milliseconds: string
            | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<
                [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
            >,
        ]

      Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>

    • Parameters

      • ...args: [
            millisecondsToken: "BLOCK",
            milliseconds: string
            | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>

    • Parameters

      • ...args: [
            countToken: "COUNT",
            count: string
            | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<
                [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
            >,
        ]

      Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>

    • Parameters

      • ...args: [
            countToken: "COUNT",
            count: string
            | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>

    • Parameters

      • ...args: [
            countToken: "COUNT",
            count: string
            | number,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<
                [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
            >,
        ]

      Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>

    • Parameters

      • ...args: [
            countToken: "COUNT",
            count: string
            | number,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>

    • Returns new or historical messages from a stream for a consumer in a group. Blocks until a message is available otherwise.

      • group: stream
      • complexity: For each stream mentioned: O(M) with M being the number of elements returned. If M is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). On the other side when XREADGROUP blocks, XADD will pay the O(N) time in order to serve the N clients blocked on the stream getting new data.
      • since: 5.0.0

      Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            noack: "NOACK",
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            noack: "NOACK",
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            noack: "NOACK",
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            noack: "NOACK",
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            countToken: "COUNT",
            count: string | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            countToken: "COUNT",
            count: string | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            countToken: "COUNT",
            count: string | number,
            noack: "NOACK",
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            countToken: "COUNT",
            count: string | number,
            noack: "NOACK",
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            countToken: "COUNT",
            count: string | number,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            countToken: "COUNT",
            count: string | number,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            countToken: "COUNT",
            count: string | number,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            noack: "NOACK",
            streamsToken: "STREAMS",
            ...args: RedisValue[],
            callback: Callback<unknown[]>,
        ]

      Returns Promise<unknown[]>

    • Parameters

      • ...args: [
            groupBlockToken: "GROUP",
            group: string
            | Buffer,
            consumer: string | Buffer,
            countToken: "COUNT",
            count: string | number,
            millisecondsToken: "BLOCK",
            milliseconds: string | number,
            noack: "NOACK",
            streamsToken: "STREAMS",
            ...args: RedisValue[],
        ]

      Returns Promise<unknown[]>

    • Returns the messages from a stream within a range of IDs in reverse order.

      • group: stream
      • complexity: O(N) with N being the number of elements returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1).
      • since: 5.0.0

      Parameters

      • key: RedisKey
      • end: string | number | Buffer
      • start: string | number | Buffer
      • Optionalcallback: Callback<[id: string, fields: string[]][]>

      Returns Promise<[id: string, fields: string[]][]>

    • Parameters

      • key: RedisKey
      • end: string | number | Buffer
      • start: string | number | Buffer
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[id: string, fields: string[]][]>

      Returns Promise<[id: string, fields: string[]][]>

    • Parameters

      • key: RedisKey
      • end: string | number | Buffer
      • start: string | number | Buffer
      • Optionalcallback: Callback<[id: Buffer, fields: Buffer[]][]>

      Returns Promise<[id: Buffer, fields: Buffer[]][]>

    • Parameters

      • key: RedisKey
      • end: string | number | Buffer
      • start: string | number | Buffer
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[id: Buffer, fields: Buffer[]][]>

      Returns Promise<[id: Buffer, fields: Buffer[]][]>

    • An internal command for replicating stream values.

      • group: stream
      • complexity: O(1)
      • since: 5.0.0

      Parameters

      • key: RedisKey
      • lastId: string | number | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • lastId: string | number | Buffer
      • maxDeletedIdToken: "MAXDELETEDID"
      • maxDeletedId: string | number | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • lastId: string | number | Buffer
      • entriesAddedToken: "ENTRIESADDED"
      • entriesAdded: string | number
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Parameters

      • key: RedisKey
      • lastId: string | number | Buffer
      • entriesAddedToken: "ENTRIESADDED"
      • entriesAdded: string | number
      • maxDeletedIdToken: "MAXDELETEDID"
      • maxDeletedId: string | number | Buffer
      • Optionalcallback: Callback<unknown>

      Returns Promise<unknown>

    • Deletes messages from the beginning of a stream.

      • group: stream
      • complexity: O(N), with N being the number of evicted entries. Constant times are very small however, since entries are organized in macro nodes containing multiple entries that can be released with a single deallocation.
      • since: 5.0.0

      Parameters

      • key: RedisKey
      • maxlen: "MAXLEN"
      • threshold: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • maxlen: "MAXLEN"
      • threshold: string | number | Buffer
      • countToken: "LIMIT"
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • maxlen: "MAXLEN"
      • equal: "="
      • threshold: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • maxlen: "MAXLEN"
      • equal: "="
      • threshold: string | number | Buffer
      • countToken: "LIMIT"
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • maxlen: "MAXLEN"
      • approximately: "~"
      • threshold: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • maxlen: "MAXLEN"
      • approximately: "~"
      • threshold: string | number | Buffer
      • countToken: "LIMIT"
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • minid: "MINID"
      • threshold: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • minid: "MINID"
      • threshold: string | number | Buffer
      • countToken: "LIMIT"
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • minid: "MINID"
      • equal: "="
      • threshold: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • minid: "MINID"
      • equal: "="
      • threshold: string | number | Buffer
      • countToken: "LIMIT"
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • minid: "MINID"
      • approximately: "~"
      • threshold: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • minid: "MINID"
      • approximately: "~"
      • threshold: string | number | Buffer
      • countToken: "LIMIT"
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Adds one or more members to a sorted set, or updates their scores. Creates the key if it doesn't exist.

      • group: sorted-set
      • complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set.
      • since: 1.2.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [key: RedisKey, incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ch: "CH", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            gt: "GT",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, gt: "GT", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            gt: "GT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            gt: "GT",
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, gt: "GT", ch: "CH", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            lt: "LT",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, lt: "LT", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            lt: "LT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            lt: "LT",
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, lt: "LT", ch: "CH", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, nx: "NX", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, nx: "NX", ch: "CH", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, nx: "NX", gt: "GT", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            ch: "CH",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, nx: "NX", lt: "LT", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            ch: "CH",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, xx: "XX", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, xx: "XX", ch: "CH", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, xx: "XX", gt: "GT", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            ch: "CH",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, xx: "XX", lt: "LT", ...data: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            ch: "CH",
            ...data: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            ch: "CH",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<string>,
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<string>

    • Parameters

      • ...args: [
            key: RedisKey,
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [key: RedisKey, incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            gt: "GT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            lt: "LT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            nx: "NX",
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...data: (string | number | Buffer)[]]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            gt: "GT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
            callback: Callback<Buffer>,
        ]

      Returns Promise<Buffer>

    • Parameters

      • ...args: [
            key: RedisKey,
            xx: "XX",
            lt: "LT",
            ch: "CH",
            incr: "INCR",
            ...data: (string | number | Buffer)[],
        ]

      Returns Promise<Buffer>

    • Returns the number of members in a sorted set.

      • group: sorted-set
      • complexity: O(1)
      • since: 1.2.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the count of members in a sorted set that have scores within a range.

      • group: sorted-set
      • complexity: O(log(N)) with N being the number of elements in the sorted set.
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • min: string | number
      • max: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the difference between multiple sorted sets.

      • group: sorted-set
      • complexity: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set.
      • since: 6.2.0

      Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[]]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<Buffer[]>

    • Stores the difference of multiple sorted sets in a key.

      • group: sorted-set
      • complexity: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set.
      • since: 6.2.0

      Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Increments the score of a member in a sorted set.

      • group: sorted-set
      • complexity: O(log(N)) where N is the number of elements in the sorted set.
      • since: 1.2.0

      Parameters

      • key: RedisKey
      • increment: string | number
      • member: string | number | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • increment: string | number
      • member: string | number | Buffer
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Returns the intersect of multiple sorted sets.

      • group: sorted-set
      • complexity: O(NK)+O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.
      • since: 6.2.0

      Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[]]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[]]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Returns the number of members of the intersect of multiple sorted sets.

      • group: sorted-set
      • complexity: O(N*K) worst case with N being the smallest input sorted set, K being the number of input sorted sets.
      • since: 7.0.0

      Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]

      Returns Promise<number>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<number>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[]]

      Returns Promise<number>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            limitToken: "LIMIT",
            limit: string | number,
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            limitToken: "LIMIT",
            limit: string | number,
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            limitToken: "LIMIT",
            limit: string | number,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            limitToken: "LIMIT",
            limit: string | number,
        ]

      Returns Promise<number>

    • Stores the intersect of multiple sorted sets in a key.

      • group: sorted-set
      • complexity: O(NK)+O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.
      • since: 2.0.0

      Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<number>

    • Returns the number of members in a sorted set within a lexicographical range.

      • group: sorted-set
      • complexity: O(log(N)) with N being the number of elements in the sorted set.
      • since: 2.8.9

      Parameters

      • key: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the highest- or lowest-scoring members from one or more sorted sets after removing them. Deletes the sorted set if the last member was popped.

      • group: sorted-set
      • complexity: O(K) + O(M*log(N)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped.
      • since: 7.0.0

      Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            min: "MIN",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            min: "MIN",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN"]

      Returns Promise<unknown>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN"]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            min: "MIN",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            min: "MIN",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            min: "MIN",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            min: "MIN",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            max: "MAX",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            max: "MAX",
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX"]

      Returns Promise<unknown>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX"]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            max: "MAX",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            max: "MAX",
            countToken: "COUNT",
            count: string | number,
            callback: Callback<unknown>,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            max: "MAX",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<unknown>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            max: "MAX",
            countToken: "COUNT",
            count: string | number,
        ]

      Returns Promise<unknown>

    • Returns the score of one or more members in a sorted set.

      • group: sorted-set
      • complexity: O(N) where N is the number of members being requested.
      • since: 6.2.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...members: (string | number | Buffer)[],
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            members: (string | number | Buffer)[],
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [key: RedisKey, members: (string | number | Buffer)[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            ...members: (string | number | Buffer)[],
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            key: RedisKey,
            members: (string | number | Buffer)[],
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [key: RedisKey, members: (string | number | Buffer)[]]

      Returns Promise<Buffer[]>

    • Returns the highest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.

      • group: sorted-set
      • complexity: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped.
      • since: 5.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns the lowest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.

      • group: sorted-set
      • complexity: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped.
      • since: 5.0.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns one or more random members from a sorted set.

      • group: sorted-set
      • complexity: O(N) where N is the number of members returned
      • since: 6.2.0

      Parameters

      • key: RedisKey
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Parameters

      • key: RedisKey
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns members in a sorted set within a range of indexes.

      • group: sorted-set
      • complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned.
      • since: 1.2.0

      Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • rev: "REV"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • rev: "REV"
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • rev: "REV"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • rev: "REV"
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • rev: "REV"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • rev: "REV"
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • rev: "REV"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • rev: "REV"
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • rev: "REV"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • rev: "REV"
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • byscore: "BYSCORE"
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • rev: "REV"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • rev: "REV"
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number | Buffer
      • stop: string | Buffer
      • bylex: "BYLEX"
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns members in a sorted set within a lexicographical range.

      • group: sorted-set
      • complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
      • since: 2.8.9

      Parameters

      • key: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns members in a sorted set within a range of scores.

      • group: sorted-set
      • complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
      • since: 1.0.5

      Parameters

      • key: RedisKey
      • min: string | number
      • max: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • min: string | number
      • max: string | number
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • min: string | number
      • max: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • min: string | number
      • max: string | number
      • withscores: "WITHSCORES"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • min: string | number
      • max: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • min: string | number
      • max: string | number
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • min: string | number
      • max: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • min: string | number
      • max: string | number
      • withscores: "WITHSCORES"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Stores a range of members from sorted set in a key.

      • group: sorted-set
      • complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements stored into the destination key.
      • since: 6.2.0

      Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • rev: "REV"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • byscore: "BYSCORE"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • byscore: "BYSCORE"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • byscore: "BYSCORE"
      • rev: "REV"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • byscore: "BYSCORE"
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • bylex: "BYLEX"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • bylex: "BYLEX"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • bylex: "BYLEX"
      • rev: "REV"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • dst: RedisKey
      • src: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • bylex: "BYLEX"
      • rev: "REV"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns the index of a member in a sorted set ordered by ascending scores.

      • group: sorted-set
      • complexity: O(log(N))
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • member: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • member: string | number | Buffer
      • withscore: "WITHSCORE"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Removes one or more members from a sorted set. Deletes the sorted set if all members were removed.

      • group: sorted-set
      • complexity: O(M*log(N)) with N being the number of elements in the sorted set and M the number of elements to be removed.
      • since: 1.2.0

      Parameters

      • ...args: [
            key: RedisKey,
            ...members: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            key: RedisKey,
            members: (string | number | Buffer)[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]

      Returns Promise<number>

    • Parameters

      • ...args: [key: RedisKey, members: (string | number | Buffer)[]]

      Returns Promise<number>

    • Removes members in a sorted set within a lexicographical range. Deletes the sorted set if all members were removed.

      • group: sorted-set
      • complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.
      • since: 2.8.9

      Parameters

      • key: RedisKey
      • min: string | number | Buffer
      • max: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Removes members in a sorted set within a range of indexes. Deletes the sorted set if all members were removed.

      • group: sorted-set
      • complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • start: string | number
      • stop: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Removes members in a sorted set within a range of scores. Deletes the sorted set if all members were removed.

      • group: sorted-set
      • complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.
      • since: 1.2.0

      Parameters

      • key: RedisKey
      • min: string | number
      • max: string | number
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Returns members in a sorted set within a range of indexes in reverse order.

      • group: sorted-set
      • complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned.
      • since: 1.2.0

      Parameters

      • key: RedisKey
      • start: string | number
      • stop: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number
      • stop: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • start: string | number
      • stop: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • start: string | number
      • stop: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns members in a sorted set within a lexicographical range in reverse order.

      • group: sorted-set
      • complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
      • since: 2.8.9

      Parameters

      • key: RedisKey
      • max: string | number | Buffer
      • min: string | number | Buffer
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • max: string | number | Buffer
      • min: string | number | Buffer
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • max: string | number | Buffer
      • min: string | number | Buffer
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • max: string | number | Buffer
      • min: string | number | Buffer
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns members in a sorted set within a range of scores in reverse order.

      • group: sorted-set
      • complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
      • since: 2.2.0

      Parameters

      • key: RedisKey
      • max: string | number
      • min: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • max: string | number
      • min: string | number
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • max: string | number
      • min: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • max: string | number
      • min: string | number
      • withscores: "WITHSCORES"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<string[]>

      Returns Promise<string[]>

    • Parameters

      • key: RedisKey
      • max: string | number
      • min: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • max: string | number
      • min: string | number
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • max: string | number
      • min: string | number
      • withscores: "WITHSCORES"
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Parameters

      • key: RedisKey
      • max: string | number
      • min: string | number
      • withscores: "WITHSCORES"
      • limitToken: "LIMIT"
      • offset: string | number
      • count: string | number
      • Optionalcallback: Callback<Buffer[]>

      Returns Promise<Buffer[]>

    • Returns the index of a member in a sorted set ordered by descending scores.

      • group: sorted-set
      • complexity: O(log(N))
      • since: 2.0.0

      Parameters

      • key: RedisKey
      • member: string | number | Buffer
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Parameters

      • key: RedisKey
      • member: string | number | Buffer
      • withscore: "WITHSCORE"
      • Optionalcallback: Callback<number>

      Returns Promise<number>

    • Iterates over members and scores of a sorted set.

      • group: sorted-set
      • complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
      • since: 2.8.0

      Parameters

      • key: RedisKey
      • cursor: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • noscores: "NOSCORES"
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • noscores: "NOSCORES"
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • noscores: "NOSCORES"
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • noscores: "NOSCORES"
      • Optionalcallback: Callback<[cursor: string, elements: string[]]>

      Returns Promise<[cursor: string, elements: string[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • noscores: "NOSCORES"
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • countToken: "COUNT"
      • count: string | number
      • noscores: "NOSCORES"
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • noscores: "NOSCORES"
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Parameters

      • key: RedisKey
      • cursor: string | number
      • patternToken: "MATCH"
      • pattern: string
      • countToken: "COUNT"
      • count: string | number
      • noscores: "NOSCORES"
      • Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>

      Returns Promise<[cursor: Buffer, elements: Buffer[]]>

    • Returns the score of a member in a sorted set.

      • group: sorted-set
      • complexity: O(1)
      • since: 1.2.0

      Parameters

      • key: RedisKey
      • member: string | number | Buffer
      • Optionalcallback: Callback<string>

      Returns Promise<string>

    • Parameters

      • key: RedisKey
      • member: string | number | Buffer
      • Optionalcallback: Callback<Buffer>

      Returns Promise<Buffer>

    • Returns the union of multiple sorted sets.

      • group: sorted-set
      • complexity: O(N)+O(M*log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set.
      • since: 6.2.0

      Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[]]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<string[]>,
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<string[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[]]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[]]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[]]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
            callback: Callback<Buffer[]>,
        ]

      Returns Promise<Buffer[]>

    • Parameters

      • ...args: [
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            withscores: "WITHSCORES",
        ]

      Returns Promise<Buffer[]>

    • Stores the union of multiple sorted sets in a key.

      • group: sorted-set
      • complexity: O(N)+O(M log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set.
      • since: 2.0.0

      Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            keys: RedisKey[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            sum: "SUM",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            min: "MIN",
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
            callback: Callback<number>,
        ]

      Returns Promise<number>

    • Parameters

      • ...args: [
            destination: RedisKey,
            numkeys: string
            | number,
            ...args: RedisValue[],
            aggregate: "AGGREGATE",
            max: "MAX",
        ]

      Returns Promise<number>